API

System APIs

GET system/extensions/{extensionId}

Get extension details

HTTP method GET
URI https://api.rambase.net/system/extensions/{extensionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {extensionId} Extension identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 3763, version 10

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.

Format:
1
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select page for more information.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
<Extension>
2
     <ExtensionId
ExtensionId

Extension identifier

>{Integer}</ExtensionId>
3
     <Status
Status

Extension status

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Extension name

>{String}</Name>
5
     <Description
Description

Extension description

>{String}</Description>
6
     <TermsAndConditions
TermsAndConditions

Terms and condition for using the extension

>{String}</TermsAndConditions>
7
     <IsActivated
IsActivated

True if extension is activated for current company

>{Boolean}</IsActivated>
8
     <ActivatedAt
ActivatedAt

Date of activation for extension

>{Datetime}</ActivatedAt>
9
     <MainImage>
10
          <MediumId
MediumId

Identifier of media

>{Integer}</MediumId>
11
          <Url
Url

Url to media

>{String}</Url>
12
          <Description
Description

Description of media. Typically used in html img alt-attribute.

>{String}</Description>
13
          <MediumLink
MediumLink

Reference to document

>{String}</MediumLink>
14
     </MainImage>
15
     <CurrentVersion
CurrentVersion

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>
16
          <ExtensionVersionId
ExtensionVersionId

Unique identifier for extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>{Integer}</ExtensionVersionId>
17
          <Version
Version

Version number for extension version (ex "1.0.0")

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>{String}</Version>
18
          <Description
Description

Description of what changes has been done in extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>{String}</Description>
19
          <ReleasedAt
ReleasedAt

Release date and time of given extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>{Datetime}</ReleasedAt>
20
          <ExtensionVersionLink
ExtensionVersionLink

Extension version reference

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

>{String}</ExtensionVersionLink>
21
     </CurrentVersion>
22
     <Publisher
Publisher

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>
23
          <PublisherId
PublisherId

Publisher identifier

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{Integer}</PublisherId>
24
          <Name
Name

Publisher name

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</Name>
25
          <Description
Description

Publisher description

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</Description>
26
          <LogoUrl
LogoUrl

Url to publisher logo

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</LogoUrl>
27
          <Email
Email

Email to the publisher

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</Email>
28
          <Prefix
Prefix

Unique prefix used for extension objects created by the publisher, e.g. custom fields.

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</Prefix>
29
          <PublisherLink
PublisherLink

Publisher reference

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

>{String}</PublisherLink>
30
     </Publisher>
31
     <Repository>
32
          <Scope
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>
33
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

>{Boolean}</IsChanged>
34
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

>
35
               <UserId
UserId

User identifier

>{Integer}</UserId>
36
               <Name
Name

Name of the user

>{String}</Name>
37
               <FirstName
FirstName

First name of the user

>{String}</FirstName>
38
               <UserLink
UserLink

User reference

>{String}</UserLink>
39
          </ChangedBy>
40
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

>{Boolean}</IsPendingDeployment>
41
     </Repository>
42
</Extension>
1
{
2
     "extension": {
3
          "extensionId
ExtensionId

Extension identifier

": "{Integer}",
4
          "status
Status

Extension status

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Extension name

": "{String}",
6
          "description
Description

Extension description

": "{String}",
7
          "termsAndConditions
TermsAndConditions

Terms and condition for using the extension

": "{String}",
8
          "isActivated
IsActivated

True if extension is activated for current company

": "{Boolean}",
9
          "activatedAt
ActivatedAt

Date of activation for extension

": "{Datetime}",
10
          "mainImage": {
11
               "mediumId
MediumId

Identifier of media

": "{Integer}",
12
               "url
Url

Url to media

": "{String}",
13
               "description
Description

Description of media. Typically used in html img alt-attribute.

": "{String}",
14
               "mediumLink
MediumLink

Reference to document

": "{String}"
15
          },
16
          "currentVersion
CurrentVersion

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": {
17
               "extensionVersionId
ExtensionVersionId

Unique identifier for extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": "{Integer}",
18
               "version
Version

Version number for extension version (ex "1.0.0")

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": "{String}",
19
               "description
Description

Description of what changes has been done in extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": "{String}",
20
               "releasedAt
ReleasedAt

Release date and time of given extension version

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": "{Datetime}",
21
               "extensionVersionLink
ExtensionVersionLink

Extension version reference

This field is greyed out because it is an expandable field. You have to add $expand=CurrentVersion in your request URI to get this field

": "{String}"
22
          },
23
          "publisher
Publisher

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": {
24
               "publisherId
PublisherId

Publisher identifier

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{Integer}",
25
               "name
Name

Publisher name

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}",
26
               "description
Description

Publisher description

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}",
27
               "logoUrl
LogoUrl

Url to publisher logo

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}",
28
               "email
Email

Email to the publisher

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}",
29
               "prefix
Prefix

Unique prefix used for extension objects created by the publisher, e.g. custom fields.

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}",
30
               "publisherLink
PublisherLink

Publisher reference

This field is greyed out because it is an expandable field. You have to add $expand=Publisher in your request URI to get this field

": "{String}"
31
          },
32
          "repository": {
33
               "scope
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}",
34
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

": "{Boolean}",
35
               "changedBy
ChangedBy

EmployeeId of the employee making the change

": {
36
                    "userId
UserId

User identifier

": "{Integer}",
37
                    "name
Name

Name of the user

": "{String}",
38
                    "firstName
FirstName

First name of the user

": "{String}",
39
                    "userLink
UserLink

User reference

": "{String}"
40
               },
41
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

": "{Boolean}"
42
          }
43
     }
44
}

Possible error codes the response might return:

Error 101814 HTTP 404 Employee not found
Error 104737 HTTP 404 Media not found