System APIs

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

System

Application

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:

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:

                                        <ApplicationVersion>
                                    

<ApplicationVersionId

ApplicationVersionId

Application version identifier

>{String}</ApplicationVersionId>

<ObjectStatus

ObjectStatus

Status of application

>{String}</ObjectStatus>

<ApplicationId

ApplicationId

Application Identifier

>{Integer}</ApplicationId>

<ApplicationName

ApplicationName

Name of application

>{String}</ApplicationName>

<ApplicationMatch

ApplicationMatch

Matching Keyword

>{String}</ApplicationMatch>

<ApplicationCommand

ApplicationCommand

Application reference

>{String}</ApplicationCommand>

<Version

Version

Unique identifier for an application version

>{Integer}</Version>

<Description

Description

Descriptive name of the application

>{String}</Description>

<ContentType

ContentType

Content Type

>{String}</ContentType>

<MasterUrl

MasterUrl

Url of application

>{String}</MasterUrl>

<RelativeUrl

RelativeUrl

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

>{String}</RelativeUrl>

<ResourceId

ResourceId

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

>{String}</ResourceId>

<ApplicationChecksum

ApplicationChecksum

The calculated checksum of the sourcecode of this application

>{String}</ApplicationChecksum>

<Type

Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

>{String}</Type>

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

<FieldOrder

FieldOrder

A json structure describing the field order

>{String}</FieldOrder>

<FieldOrderChecksum

FieldOrderChecksum

An md5 hash of the fieldorder

>{String}</FieldOrderChecksum>

                                             </CustomFieldOrder>
                                    

<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

<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

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

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

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

                                                  </Translation>
                                    

                                             </Translations>
                                    

                                             <Components>
                                    

                                                  <ApplicationVersion>
                                    

<ApplicationVersionId

ApplicationVersionId

Application version identifier

>{String}</ApplicationVersionId>

<ObjectStatus

ObjectStatus

Status of application

>{String}</ObjectStatus>

<ApplicationId

ApplicationId

Application Identifier

>{Integer}</ApplicationId>

<ApplicationName

ApplicationName

Name of application

>{String}</ApplicationName>

<ApplicationMatch

ApplicationMatch

Matching Keyword

>{String}</ApplicationMatch>

<Version

Version

Unique identifier for an application version

>{Integer}</Version>

<MasterUrl

MasterUrl

Url of application

>{String}</MasterUrl>

<Description

Description

Descriptive name of the application

>{String}</Description>

<ApplicationChecksum

ApplicationChecksum

The calculated checksum of the sourcecode of this application

>{String}</ApplicationChecksum>

<Type

Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

>{String}</Type>

                                                       <UserSettings>
                                    

<WidgetId

WidgetId

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

>{String}</WidgetId>

                                                            <Placement>
                                    

<Row

Row

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

>{Integer}</Row>

<Column

Column

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

>{Integer}</Column>

                                                            </Placement>
                                    

<SerializedSettingsObject

SerializedSettingsObject

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

>{String}</SerializedSettingsObject>

                                                       </UserSettings>
                                    

<ApplicationVersionLink

ApplicationVersionLink

Application reference

>{String}</ApplicationVersionLink>

                                                  </ApplicationVersion>
                                    

                                             </Components>
                                    

<ApplicationVersionLink

ApplicationVersionLink

Application reference

>{String}</ApplicationVersionLink>

                                        </ApplicationVersion>
                                    

{

                                             "applicationVersion": {
                                    

"applicationVersionId

ApplicationVersionId

Application version identifier

": "{String}",

"objectStatus

ObjectStatus

Status of application

": "{String}",

"applicationId

ApplicationId

Application Identifier

": "{Integer}",

"applicationName

ApplicationName

Name of application

": "{String}",

"applicationMatch

ApplicationMatch

Matching Keyword

": "{String}",

"applicationCommand

ApplicationCommand

Application reference

": "{String}",

"version

Version

Unique identifier for an application version

": "{Integer}",

"description

Description

Descriptive name of the application

": "{String}",

"contentType

ContentType

Content Type

": "{String}",

"masterUrl

MasterUrl

Url of application

": "{String}",

"relativeUrl

RelativeUrl

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

": "{String}",

"resourceId

ResourceId

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

": "{String}",

"applicationChecksum

ApplicationChecksum

The calculated checksum of the sourcecode of this application

": "{String}",

"type

Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

": "{String}",

"customFieldOrder

CustomFieldOrder

": {

"fieldOrder

FieldOrder

A json structure describing the field order

": "{String}",

"fieldOrderChecksum

FieldOrderChecksum

An md5 hash of the fieldorder

": "{String}"

},

"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

": [

{

"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}",

"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}",

"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}"

}

],

                                                  "components": [
                                    

{

"applicationVersionId

ApplicationVersionId

Application version identifier

": "{String}",

"objectStatus

ObjectStatus

Status of application

": "{String}",

"applicationId

ApplicationId

Application Identifier

": "{Integer}",

"applicationName

ApplicationName

Name of application

": "{String}",

"applicationMatch

ApplicationMatch

Matching Keyword

": "{String}",

"version

Version

Unique identifier for an application version

": "{Integer}",

"masterUrl

MasterUrl

Url of application

": "{String}",

"description

Description

Descriptive name of the application

": "{String}",

"applicationChecksum

ApplicationChecksum

The calculated checksum of the sourcecode of this application

": "{String}",

"type

Type

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

": "{String}",

                                                            "userSettings": {
                                    

"widgetId

WidgetId

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

": "{String}",

                                                                 "placement": {
                                    

"row

Row

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

": "{Integer}",

"column

Column

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

": "{Integer}"

},

"serializedSettingsObject

SerializedSettingsObject

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

": "{String}"

},

"applicationVersionLink

ApplicationVersionLink

Application reference

": "{String}"

}

],

"applicationVersionLink

ApplicationVersionLink

Application reference

": "{String}"

}

}

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