API

RamBase REST APIs

GET system/applications/{applicationId}/versions/{applicationVersionId}

Application details for provided identifier

HTTP method GET
URI https://api.rambase.net/system/applications/{applicationId}/versions/{applicationVersionId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {applicationId} Application version identifier
Integer, minimum 10000
- URI parameter {applicationVersionId} Unique identifier for an application version
Integer, minimum 100
Successful HTTP status code 200
API resource identifier 2578, version 38

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
<ApplicationVersion>
2
     <ApplicationVersionId
ApplicationVersionId

Unique identifier for an application version

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

Status of application

Possible domain values can be found here

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

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

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

Name of application

>{String}</Name>
6
     <DescriptiveName
DescriptiveName

Descriptive name of the application

>{String}</DescriptiveName>
7
     <Description
Description

The descriptive tag of an application or component

>{String}</Description>
8
     <Namespace
Namespace

Namespace of the Application

>{String}</Namespace>
9
     <MasterUrl
MasterUrl

Url of application

>{String}</MasterUrl>
10
     <LookupKey
LookupKey

Matching Keyword

>{String}</LookupKey>
11
     <LookupPriority
LookupPriority

The priority of whitch the application lookup will select applications with the same applicationmatch.

>{Integer}</LookupPriority>
12
     <ContentType
ContentType

Content Type

Possible domain values can be found here

>{String}</ContentType>
13
     <ChangeDescription
ChangeDescription

Version description.

>{String}</ChangeDescription>
14
     <CreatedAt
CreatedAt

Date and time when this version was created

>{Datetime}</CreatedAt>
15
     <CreatedBy
CreatedBy

Id of person who created this version

>
16
          <UserId
UserId

User identifier

>{Integer}</UserId>
17
          <FirstName
FirstName

First name of the user

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

Name of the user

>{String}</Name>
19
          <UserLink
UserLink

User reference

>{String}</UserLink>
20
     </CreatedBy>
21
     <RestrictedToCompany
RestrictedToCompany

Shortname for company database name (eg. TEM-NO). Application can only run for the company.

>
22
          <CompanyId
CompanyId

Company identifier

>{Integer}</CompanyId>
23
          <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
24
          <CompanyLink
CompanyLink

Company reference

>{String}</CompanyLink>
25
     </RestrictedToCompany>
26
     <Permission
Permission

Permission to use this application

>
27
          <PermissionId
PermissionId

Permission identifier

>{Integer}</PermissionId>
28
          <Name
Name

Name of the permission

>{Integer}</Name>
29
          <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
30
     </Permission>
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
     <RedirectToApplication>
43
          <ApplicationId
ApplicationId

Wrapper application. This field holds the Id for the main application. Wrapper Apps are used to have different application match names for the same application (ex: CUS and CUSTOMER)

>{Integer}</ApplicationId>
44
          <ApplicationLink
ApplicationLink

Application reference

>{String}</ApplicationLink>
45
     </RedirectToApplication>
46
     <CustomFieldOrder
CustomFieldOrder

It is possible for a customer to rearrange the fields within a component. If they choose to do so for one or more of the components in this application, the fieldorder will contain a json structure that will keep information about the field order they have selected.

>
47
          <FieldOrder
FieldOrder

A json structure describing the field order

>{String}</FieldOrder>
48
     </CustomFieldOrder>
49
     <Translations
Translations

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

>
50
          <Translation
Translation

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

>
51
               <Status
Status

Status of the translation of the application for this language

Possible domain values can be found here

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

>{Integer}</Status>
52
               <IsCertified
IsCertified

True if the translation has been certified.

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

>{Boolean}</IsCertified>
53
               <Language
Language

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

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

>{String}</Language>
54
          </Translation>
55
     </Translations>
56
</ApplicationVersion>
1
{
2
     "applicationVersion": {
3
          "applicationVersionId
ApplicationVersionId

Unique identifier for an application version

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

Status of application

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

": "{String}",
6
          "name
Name

Name of application

": "{String}",
7
          "descriptiveName
DescriptiveName

Descriptive name of the application

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

The descriptive tag of an application or component

": "{String}",
9
          "namespace
Namespace

Namespace of the Application

": "{String}",
10
          "masterUrl
MasterUrl

Url of application

": "{String}",
11
          "lookupKey
LookupKey

Matching Keyword

": "{String}",
12
          "lookupPriority
LookupPriority

The priority of whitch the application lookup will select applications with the same applicationmatch.

": "{Integer}",
13
          "contentType
ContentType

Content Type

Possible domain values can be found here

": "{String}",
14
          "changeDescription
ChangeDescription

Version description.

": "{String}",
15
          "createdAt
CreatedAt

Date and time when this version was created

": "{Datetime}",
16
          "createdBy
CreatedBy

Id of person who created this version

": {
17
               "userId
UserId

User identifier

": "{Integer}",
18
               "firstName
FirstName

First name of the user

": "{String}",
19
               "name
Name

Name of the user

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

User reference

": "{String}"
21
          },
22
          "restrictedToCompany
RestrictedToCompany

Shortname for company database name (eg. TEM-NO). Application can only run for the company.

": {
23
               "companyId
CompanyId

Company identifier

": "{Integer}",
24
               "database
Database

Abbreviation/code to identify the company

": "{String}",
25
               "companyLink
CompanyLink

Company reference

": "{String}"
26
          },
27
          "permission
Permission

Permission to use this application

": {
28
               "permissionId
PermissionId

Permission identifier

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

Name of the permission

": "{Integer}",
30
               "permissionLink
PermissionLink

Permission reference

": "{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
          "redirectToApplication": {
44
               "applicationId
ApplicationId

Wrapper application. This field holds the Id for the main application. Wrapper Apps are used to have different application match names for the same application (ex: CUS and CUSTOMER)

": "{Integer}",
45
               "applicationLink
ApplicationLink

Application reference

": "{String}"
46
          },
47
          "customFieldOrder
CustomFieldOrder

It is possible for a customer to rearrange the fields within a component. If they choose to do so for one or more of the components in this application, the fieldorder will contain a json structure that will keep information about the field order they have selected.

": {
48
               "fieldOrder
FieldOrder

A json structure describing the field order

": "{String}"
49
          },
50
          "translations
Translations

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

": [
51
               {
52
                    "status
Status

Status of the translation of the application for this language

Possible domain values can be found here

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

": "{Integer}",
53
                    "isCertified
IsCertified

True if the translation has been certified.

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

": "{Boolean}",
54
                    "language
Language

Three character code following the ISO 639-2 standard.

Possible domain values can be found here

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

": "{String}"
55
               }
56
          ]
57
     }
58
}

Possible error codes the response might return:

Error 101015 HTTP 404 Permission not found