API

System APIs

GET system/application-versions/{applicationMatch}?applicationParameter={applicationParamter}&new-framework={newFramework}

This resource will scan all applications for an application with the specific ApplicationMatch. All application filters will be scanned, and only one application version will be returned.

HTTP method GET
URI https://api.rambase.net/system/application-versions/{applicationMatch}?applicationParameter={applicationParamter}&new-framework={newFramework}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {applicationMatch} Matching Keyword
String
Successful HTTP status code 200
API resource identifier 1832, version 12

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.

applicationParameter String, optional Application parameter. In "COA/12345" COA will be applicationMatch and 12345 will be ApplicationParameter
new-framework Boolean, optional Will be removed when new version of client framework is released
$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

Application version identifier

>
{String}</ApplicationVersionId>
3
     <ObjectStatus
ObjectStatus

Status of application

>
{String}</ObjectStatus>
4
     <ApplicationId
ApplicationId

Application Identifier

>
{Integer}</ApplicationId>
5
     <ApplicationName
ApplicationName

Name of application

>
{String}</ApplicationName>
6
     <ApplicationMatch
ApplicationMatch

Matching Keyword

>
{String}</ApplicationMatch>
7
     <ApplicationCommand
ApplicationCommand

Application reference

>
{String}</ApplicationCommand>
8
     <Version
Version

Unique identifier for an application version

>
{Integer}</Version>
9
     <Description
Description

Descriptive name of the application

>
{String}</Description>
10
     <ContentType
ContentType

Content Type

>
{String}</ContentType>
11
     <MasterUrl
MasterUrl

Url of application

>
{String}</MasterUrl>
12
     <RelativeUrl
RelativeUrl

The relative url where this app will be stored on the web server

>
{String}</RelativeUrl>
13
     <ResourceId
ResourceId

Different types of apps can have different types of resourceid. This is only used for legacy applications

>
{String}</ResourceId>
14
     <ApplicationChecksum
ApplicationChecksum

The calculated checksum of the sourcecode of this application

>
{String}</ApplicationChecksum>
15
     <Type
Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

>
{String}</Type>
16
     <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.

>
17
          <FieldOrder
FieldOrder

A json structure describing the field order

>
{String}</FieldOrder>
18
          <FieldOrderChecksum
FieldOrderChecksum

An md5 hash of the fieldorder

>
{String}</FieldOrderChecksum>
19
     </CustomFieldOrder>
20
     <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

>
21
          <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

>
22
               <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>
23
               <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>
24
               <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>
25
          </Translation>
26
     </Translations>
27
     <Components>
28
          <ApplicationVersion>
29
               <ApplicationVersionId
ApplicationVersionId

Application version identifier

>
{String}</ApplicationVersionId>
30
               <ObjectStatus
ObjectStatus

Status of application

>
{String}</ObjectStatus>
31
               <ApplicationId
ApplicationId

Application Identifier

>
{Integer}</ApplicationId>
32
               <ApplicationName
ApplicationName

Name of application

>
{String}</ApplicationName>
33
               <ApplicationMatch
ApplicationMatch

Matching Keyword

>
{String}</ApplicationMatch>
34
               <Version
Version

Unique identifier for an application version

>
{Integer}</Version>
35
               <MasterUrl
MasterUrl

Url of application

>
{String}</MasterUrl>
36
               <Description
Description

Descriptive name of the application

>
{String}</Description>
37
               <ApplicationChecksum
ApplicationChecksum

The calculated checksum of the sourcecode of this application

>
{String}</ApplicationChecksum>
38
               <Type
Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

>
{String}</Type>
39
               <UserSettings>
40
                    <WidgetId
WidgetId

A unique id that will indentify a specific widget on a dashboard

>
{String}</WidgetId>
41
                    <Placement>
42
                         <Row
Row

The placement of a component (widget) in a dashboard.

>
{Integer}</Row>
43
                         <Column
Column

The placement of a component (widget) in a dashboard.

>
{Integer}</Column>
44
                    </Placement>
45
                    <SerializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

>
{String}</SerializedSettingsObject>
46
               </UserSettings>
47
               <ApplicationVersionLink
ApplicationVersionLink

Application reference

>
{String}</ApplicationVersionLink>
48
          </ApplicationVersion>
49
     </Components>
50
     <ApplicationVersionLink
ApplicationVersionLink

Application reference

>
{String}</ApplicationVersionLink>
51
</ApplicationVersion>
1
{
2
     "applicationVersion": {
3
          "applicationVersionId
ApplicationVersionId

Application version identifier

":
"{String}",
4
          "objectStatus
ObjectStatus

Status of application

":
"{String}",
5
          "applicationId
ApplicationId

Application Identifier

":
"{Integer}",
6
          "applicationName
ApplicationName

Name of application

":
"{String}",
7
          "applicationMatch
ApplicationMatch

Matching Keyword

":
"{String}",
8
          "applicationCommand
ApplicationCommand

Application reference

":
"{String}",
9
          "version
Version

Unique identifier for an application version

":
"{Integer}",
10
          "description
Description

Descriptive name of the application

":
"{String}",
11
          "contentType
ContentType

Content Type

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

Url of application

":
"{String}",
13
          "relativeUrl
RelativeUrl

The relative url where this app will be stored on the web server

":
"{String}",
14
          "resourceId
ResourceId

Different types of apps can have different types of resourceid. This is only used for legacy applications

":
"{String}",
15
          "applicationChecksum
ApplicationChecksum

The calculated checksum of the sourcecode of this application

":
"{String}",
16
          "type
Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

":
"{String}",
17
          "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.

":
{
18
               "fieldOrder
FieldOrder

A json structure describing the field order

":
"{String}",
19
               "fieldOrderChecksum
FieldOrderChecksum

An md5 hash of the fieldorder

":
"{String}"
20
          },
21
          "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

":
[
22
               {
23
                    "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}",
24
                    "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}",
25
                    "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}"
26
               }
27
          ],
28
          "components": [
29
               {
30
                    "applicationVersionId
ApplicationVersionId

Application version identifier

":
"{String}",
31
                    "objectStatus
ObjectStatus

Status of application

":
"{String}",
32
                    "applicationId
ApplicationId

Application Identifier

":
"{Integer}",
33
                    "applicationName
ApplicationName

Name of application

":
"{String}",
34
                    "applicationMatch
ApplicationMatch

Matching Keyword

":
"{String}",
35
                    "version
Version

Unique identifier for an application version

":
"{Integer}",
36
                    "masterUrl
MasterUrl

Url of application

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

Descriptive name of the application

":
"{String}",
38
                    "applicationChecksum
ApplicationChecksum

The calculated checksum of the sourcecode of this application

":
"{String}",
39
                    "type
Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

":
"{String}",
40
                    "userSettings": {
41
                         "widgetId
WidgetId

A unique id that will indentify a specific widget on a dashboard

":
"{String}",
42
                         "placement": {
43
                              "row
Row

The placement of a component (widget) in a dashboard.

":
"{Integer}",
44
                              "column
Column

The placement of a component (widget) in a dashboard.

":
"{Integer}"
45
                         },
46
                         "serializedSettingsObject
SerializedSettingsObject

A widget can have different settings. These settings are stored here as a json serialized string

":
"{String}"
47
                    },
48
                    "applicationVersionLink
ApplicationVersionLink

Application reference

":
"{String}"
49
               }
50
          ],
51
          "applicationVersionLink
ApplicationVersionLink

Application reference

":
"{String}"
52
     }
53
}

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 101013 HTTP 404 Sub-module not found
Error 101420 HTTP 404 Setting definition not found