GET system/applications/{applicationId}

Updates information about an existing application.

Note: Log in to check if your API client have access to run this resource
Version: 18
Success HTTP Status Code: 200

Uri parameters

{applicationId} Integer Application identifier

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 is 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 Use to show an additional descriptional field for fields that are using Domain Values.
$select String, optional Use to define the fields to return in the result. Accepts a comma-separated list of Output Field names. See the Expand and Select page for more information about this.
$db String, optional Set the database to use for the request
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "json"
$lang String, optional Use to get localized responses. Supported formats are 3-letter ISO-639-1 [lll], 2-letter ISO-639-2 [ll], or a combination of a two-letter language code and a two-letter country code ISO-639-2 and ISO-3166-1 [ll_CC], [ll-CC]
$useMinimumVersion Integer, optional This can be used to test a new version of a resource when your ApiClient is running an older, deprecated, version of a resource. $useminimumversion can be used to test against a newer version of the resource. See the Deprecated APIs page for more information about this.

See the page about filters and sorting on how to use filter parameters and named filters.

See the page 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
<Application>
2
     <ApplicationId
ApplicationId

Application identifier

>
{Integer}</ApplicationId>
3
     <HighestApplicationVersion>
4
          <ApplicationVersionId
ApplicationVersionId

Unique identifier for an application version

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

Status of application

Possible domain values can be found here when logged in

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

Type of HTML5 component. Used for widgets.

Possible domain values can be found here when logged in

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

Name of application

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

Descriptive name of the application

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

The descriptive tag of an application or component

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

Namespace of the Application

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

Url of application

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

Matching Keyword

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

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

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

Content Type

Possible domain values can be found here when logged in

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

Version description.

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

Date and time when this version was created

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

Id of person who created this version

>
18
               <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
22
          </CreatedBy>
23
          <RestrictedToCompany
RestrictedToCompany

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

>
24
               <CompanyId
CompanyId

Company identifier

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

Abbreviation/code to identify the company

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

Company reference

>
{String}</CompanyLink>
27
          </RestrictedToCompany>
28
          <Permission
Permission

Permission to use this application

>
29
               <PermissionId
PermissionId

Permission identifier

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

Name of the permission

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

Permission reference

>
{String}</PermissionLink>
32
          </Permission>
33
          <Repository>
34
               <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 when logged in

>
{String}</Scope>
35
               <IsChanged
IsChanged

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

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

EmployeeId of the employee making the change

>
37
                    <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

>
{String}</UserLink>
41
               </ChangedBy>
42
               <IsPendingDeployment
IsPendingDeployment

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

>
{Boolean}</IsPendingDeployment>
43
          </Repository>
44
          <RedirectToApplication>
45
               <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>
46
               <ApplicationLink
ApplicationLink

Application reference

>
{String}</ApplicationLink>
47
          </RedirectToApplication>
48
          <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.

>
49
               <FieldOrder
FieldOrder

A json structure describing the field order

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

An md5 hash of the fieldorder

>
{String}</FieldOrderChecksum>
51
          </CustomFieldOrder>
52
          <ApplicationVersionLink
ApplicationVersionLink

Application reference

>
{String}</ApplicationVersionLink>
53
     </HighestApplicationVersion>
54
     <ApplicationLink
ApplicationLink

Application reference

>
{String}</ApplicationLink>
55
</Application>
1
{
2
     "application": {
3
          "applicationId
ApplicationId

Application identifier

":
"{Integer}",
4
          "highestApplicationVersion": {
5
               "applicationVersionId
ApplicationVersionId

Unique identifier for an application version

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

Status of application

Possible domain values can be found here when logged in

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

Type of HTML5 component. Used for widgets.

Possible domain values can be found here when logged in

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

Name of application

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

Descriptive name of the application

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

The descriptive tag of an application or component

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

Namespace of the Application

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

Url of application

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

Matching Keyword

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

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

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

Content Type

Possible domain values can be found here when logged in

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

Version description.

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

Date and time when this version was created

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

Id of person who created this version

":
{
19
                    "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
23
               },
24
               "restrictedToCompany
RestrictedToCompany

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

":
{
25
                    "companyId
CompanyId

Company identifier

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

Abbreviation/code to identify the company

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

Company reference

":
"{String}"
28
               },
29
               "permission
Permission

Permission to use this application

":
{
30
                    "permissionId
PermissionId

Permission identifier

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

Name of the permission

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

Permission reference

":
"{String}"
33
               },
34
               "repository": {
35
                    "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 when logged in

":
"{String}",
36
                    "isChanged
IsChanged

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

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

EmployeeId of the employee making the change

":
{
38
                         "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

":
"{String}"
42
                    },
43
                    "isPendingDeployment
IsPendingDeployment

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

":
"{Boolean}"
44
               },
45
               "redirectToApplication": {
46
                    "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}",
47
                    "applicationLink
ApplicationLink

Application reference

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

":
{
50
                    "fieldOrder
FieldOrder

A json structure describing the field order

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

An md5 hash of the fieldorder

":
"{String}"
52
               },
53
               "applicationVersionLink
ApplicationVersionLink

Application reference

":
"{String}"
54
          },
55
          "applicationLink
ApplicationLink

Application reference

":
"{String}"
56
     }
57
}

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 100212 HTTP 404 Application not found
Error 102868 HTTP 404 Application version not found
Error 101814 HTTP 404 Employee not found
Error 101015 HTTP 404 Permission not found