System APIs
Create new extension
| HTTP method | POST |
| URI | https://api.rambase.net/system/extensions |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 3764, version 8 |
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
Extension name
>{String}</Name>Description
Extension description
This field is optional.
>{String}</Description>TermsAndConditions
Terms and condition for using the extension
This field is optional.
>{String}</TermsAndConditions>Publisher
This field is optional.
>PublisherId
Publisher identifier
Minimum value: 100000
This field is optional.
>{Integer}</PublisherId>Name
Required/mandatory field
Extension name
": "{String}",Description
Extension description
This field is optional.
": "{String}",TermsAndConditions
Terms and condition for using the extension
This field is optional.
": "{String}",Publisher
This field is optional.
": {PublisherId
Publisher identifier
Minimum value: 100000
This field is optional.
": "{Integer}"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.
ExtensionId
Extension identifier
>{Integer}</ExtensionId>Name
Extension name
>{String}</Name>Description
Extension description
>{String}</Description>TermsAndConditions
Terms and condition for using the extension
>{String}</TermsAndConditions>IsActivated
True if extension is activated for current company
>{Boolean}</IsActivated>ActivatedAt
Date of activation for extension
>{Datetime}</ActivatedAt>MediumId
Identifier of media
>{Integer}</MediumId>Url
Url to media
>{String}</Url>Description
Description of media. Typically used in html img alt-attribute.
>{String}</Description>MediumLink
Reference to document
>{String}</MediumLink>ExtensionVersionId
Unique identifier for extension version
>{Integer}</ExtensionVersionId>Version
Version number for extension version (ex "1.0.0")
>{String}</Version>Description
Description of what changes has been done in extension version
>{String}</Description>ReleasedAt
Release date and time of given extension version
>{Datetime}</ReleasedAt>ExtensionVersionLink
Extension version reference
>{String}</ExtensionVersionLink>PublisherId
Publisher identifier
>{Integer}</PublisherId>Name
Publisher name
>{String}</Name>Description
Publisher description
>{String}</Description>LogoUrl
Url to publisher logo
>{String}</LogoUrl>Email to the publisher
>{String}</Email>Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
>{String}</Prefix>PublisherLink
Publisher reference
>{String}</PublisherLink>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>ExtensionId
Extension identifier
": "{Integer}",Status
Extension status
Possible domain values can be found here
": "{Integer}",Name
Extension name
": "{String}",Description
Extension description
": "{String}",TermsAndConditions
Terms and condition for using the extension
": "{String}",IsActivated
True if extension is activated for current company
": "{Boolean}",ActivatedAt
Date of activation for extension
": "{Datetime}",MediumId
Identifier of media
": "{Integer}",Url
Url to media
": "{String}",Description
Description of media. Typically used in html img alt-attribute.
": "{String}",MediumLink
Reference to document
": "{String}",ExtensionVersionId
Unique identifier for extension version
": "{Integer}",Version
Version number for extension version (ex "1.0.0")
": "{String}",Description
Description of what changes has been done in extension version
": "{String}",ReleasedAt
Release date and time of given extension version
": "{Datetime}",ExtensionVersionLink
Extension version reference
": "{String}",PublisherId
Publisher identifier
": "{Integer}",Name
Publisher name
": "{String}",Description
Publisher description
": "{String}",LogoUrl
Url to publisher logo
": "{String}",Email to the publisher
": "{String}",Prefix
Unique prefix used for extension objects created by the publisher, e.g. custom fields.
": "{String}",PublisherLink
Publisher reference
": "{String}"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 104746 HTTP 404 | Publisher not found |