System APIs
Create new publisher
| HTTP method | POST |
| URI | https://api.rambase.net/system/publishers |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3787, version 5 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Publisher name
>{String}</Name>Description
Publisher description
This field is optional.
>{String}</Description>Required/mandatory field
Email to the publisher
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
>{String}</Email>LogoUrl
Url to publisher logo
Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$
This field is optional.
>{String}</LogoUrl>Prefix
Required/mandatory field
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
>{String}</Prefix>Name
Required/mandatory field
Publisher name
": "{String}",Description
Publisher description
This field is optional.
": "{String}",Required/mandatory field
Email to the publisher
Input must match the following regular expression pattern: ^\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*$
": "{String}",LogoUrl
Url to publisher logo
Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$
This field is optional.
": "{String}",Prefix
Required/mandatory field
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
": "{String}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
PublisherId
Publisher identifier
>{Integer}</PublisherId>Name
Publisher name
>{String}</Name>Description
Publisher description
>{String}</Description>Email to the publisher
>{String}</Email>LogoUrl
Url to publisher logo
>{String}</LogoUrl>Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
>{String}</Prefix>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>{Datetime}</UpdatedAt>Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
Possible domain values can be found here
>{String}</Scope>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>PublisherId
Publisher identifier
": "{Integer}",Status
Publisher status
Possible domain values can be found here
": "{String}",Name
Publisher name
": "{String}",Description
Publisher description
": "{String}",Email to the publisher
": "{String}",LogoUrl
Url to publisher logo
": "{String}",Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": "{Datetime}",Scope
Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.
Possible domain values can be found here
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101079 HTTP 400 | Mismatch in size of revision parameters |
| Error 105042 HTTP 400 | Prefix is required |
| Error 105041 HTTP 400 | Prefix already in use! Please select a unique prefix. |