System APIs
Updates information about an existing application.
| HTTP method | GET |
| URI | https://api.rambase.net/system/applications/{applicationId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {applicationId} |
Application identifier
Integer, minimum 10000 |
| Successful HTTP status code | 200 |
| API resource identifier | 2362, version 18 |
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.
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. |
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.
ApplicationId
Application identifier
>{Integer}</ApplicationId>ApplicationVersionId
Unique identifier for an application version
>{Integer}</ApplicationVersionId>Type
Type of HTML5 component. Used for widgets.
Possible domain values can be found here
>{String}</Type>Name
Name of application
>{String}</Name>DescriptiveName
Descriptive name of the application
>{String}</DescriptiveName>Description
The descriptive tag of an application or component
>{String}</Description>Namespace
Namespace of the Application
>{String}</Namespace>MasterUrl
Url of application
>{String}</MasterUrl>LookupKey
Matching Keyword
>{String}</LookupKey>LookupPriority
The priority of whitch the application lookup will select applications with the same applicationmatch.
>{Integer}</LookupPriority>ChangeDescription
Version description.
>{String}</ChangeDescription>CreatedAt
Date and time when this version was created
>{Datetime}</CreatedAt>CreatedBy
Id of person who created this version
>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>RestrictedToCompany
Shortname for company database name (eg. TEM-NO). Application can only run for the company.
>CompanyId
Company identifier
>{Integer}</CompanyId>Database
Abbreviation/code to identify the company
>{String}</Database>CompanyLink
Company reference
>{String}</CompanyLink>Permission
Permission to use this application
>PermissionId
Permission identifier
>{Integer}</PermissionId>Name
Name of the permission
>{Integer}</Name>PermissionLink
Permission reference
>{String}</PermissionLink>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>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>ApplicationLink
Application reference
>{String}</ApplicationLink>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
A json structure describing the field order
>{String}</FieldOrder>FieldOrderChecksum
An md5 hash of the fieldorder
>{String}</FieldOrderChecksum>ApplicationVersionLink
Application reference
>{String}</ApplicationVersionLink>ApplicationLink
Application reference
>{String}</ApplicationLink>ApplicationId
Application identifier
": "{Integer}",ApplicationVersionId
Unique identifier for an application version
": "{Integer}",Status
Status of application
Possible domain values can be found here
": "{Integer}",Type
Type of HTML5 component. Used for widgets.
Possible domain values can be found here
": "{String}",Name
Name of application
": "{String}",DescriptiveName
Descriptive name of the application
": "{String}",Description
The descriptive tag of an application or component
": "{String}",Namespace
Namespace of the Application
": "{String}",MasterUrl
Url of application
": "{String}",LookupKey
Matching Keyword
": "{String}",LookupPriority
The priority of whitch the application lookup will select applications with the same applicationmatch.
": "{Integer}",ContentType
Content Type
Possible domain values can be found here
": "{String}",ChangeDescription
Version description.
": "{String}",CreatedAt
Date and time when this version was created
": "{Datetime}",CreatedBy
Id of person who created this version
": {UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"RestrictedToCompany
Shortname for company database name (eg. TEM-NO). Application can only run for the company.
": {CompanyId
Company identifier
": "{Integer}",Database
Abbreviation/code to identify the company
": "{String}",CompanyLink
Company reference
": "{String}"Permission
Permission to use this application
": {PermissionId
Permission identifier
": "{Integer}",Name
Name of the permission
": "{Integer}",PermissionLink
Permission 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}"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}",ApplicationLink
Application reference
": "{String}"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
A json structure describing the field order
": "{String}",FieldOrderChecksum
An md5 hash of the fieldorder
": "{String}"ApplicationVersionLink
Application reference
": "{String}"ApplicationLink
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 101015 HTTP 404 | Permission not found |