API

System APIs

GET system/applications

Lists applications

HTTP method GET
URI https://api.rambase.net/system/applications
Supported formats Xml, Html, Json (ex. $format=json)
Maximum page size ($top) 80
Successful HTTP status code 200
API resource identifier 2576, 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.

$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
$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.
$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.
$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.
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$top String, optional Specifies number of rows to return in each page. Maximum limit is specific for each API resource. Default value is 10.
$pageKey String, optional Use to navigate to first, previous, next or last page in list. Add $expand=PagingDetails to add the different keys to the response.
$filter String, optional Use to filter the result list, see the Filtering and sorting page for more information.
$orderby String, optional Use to order the result list, see the Filtering and sorting page for more information.
$inlinecount String, optional Set to "allpages" to include total number of rows in the response. Possible values are: "allpages", "none"

Read more about filters and sorting on how to use filter parameters and named filters.

ApplicationId Integer Application identifier.

Read more about filters and sorting on how to use sortable parameters

ApplicationId Integer Application identifier

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
<Applications>
2
     <Application>
3
          <ApplicationId
ApplicationId

Application identifier

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

Unique identifier for an application version

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

Status of application

Possible domain values can be found here

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

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

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

Name of application

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

Descriptive name of the application

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

The descriptive tag of an application or component

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

Namespace of the Application

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

Url of application

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

Matching Keyword

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

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

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

Content Type

Possible domain values can be found here

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

Version description.

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

Date and time when this version was created

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

Id of person who created this version

>
19
                    <UserId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

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

>
25
                    <Database
Database

Abbreviation/code to identify the company

>{String}</Database>
26
               </RestrictedToCompany>
27
               <Permission>
28
                    <PermissionId
PermissionId

Permission to use this application

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

Permission reference

>{String}</PermissionLink>
30
               </Permission>
31
               <RedirectToApplication>
32
                    <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>
33
                    <ApplicationLink
ApplicationLink

Application reference

>{String}</ApplicationLink>
34
               </RedirectToApplication>
35
               <ApplicationVersionLink
ApplicationVersionLink

Application reference

>{String}</ApplicationVersionLink>
36
          </HighestApplicationVersion>
37
          <ApplicationLink
ApplicationLink

Application reference

>{String}</ApplicationLink>
38
     </Application>
39
     <Paging
Paging

Detailed paging information for this list.

>
40
          <PageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

>{Integer}</PageSize>
41
          <Position
Position

Position of the first element in the list

>{Integer}</Position>
42
          <Page
Page

Page index

>{Integer}</Page>
43
          <FirstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

>{String}</FirstPageKey>
44
          <FirstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

>{String}</FirstPage>
45
          <PreviousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

>{String}</PreviousPageKey>
46
          <PreviousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

>{String}</PreviousPage>
47
          <NextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

>{String}</NextPageKey>
48
          <NextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

>{String}</NextPage>
49
          <LastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

>{String}</LastPageKey>
50
          <LastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

>{String}</LastPage>
51
          <Size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

>{Integer}</Size>
52
     </Paging>
53
</Applications>
1
{
2
     "applications": [
3
          {
4
               "applicationId
ApplicationId

Application identifier

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

Unique identifier for an application version

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

Status of application

Possible domain values can be found here

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

Type of HTML5 component. Used for widgets.

Possible domain values can be found here

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

Name of application

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

Descriptive name of the application

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

The descriptive tag of an application or component

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

Namespace of the Application

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

Url of application

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

Matching Keyword

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

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

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

Content Type

Possible domain values can be found here

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

Version description.

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

Date and time when this version was created

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

Id of person who created this version

": {
20
                         "userId
UserId

User identifier

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

Name of the user

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

First name of the user

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

User reference

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

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

": {
26
                         "database
Database

Abbreviation/code to identify the company

": "{String}"
27
                    },
28
                    "permission": {
29
                         "permissionId
PermissionId

Permission to use this application

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

Permission reference

": "{String}"
31
                    },
32
                    "redirectToApplication": {
33
                         "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}",
34
                         "applicationLink
ApplicationLink

Application reference

": "{String}"
35
                    },
36
                    "applicationVersionLink
ApplicationVersionLink

Application reference

": "{String}"
37
               },
38
               "applicationLink
ApplicationLink

Application reference

": "{String}"
39
          }
40
     ],
41
     "paging
Paging

Detailed paging information for this list.

": {
42
          "pageSize
PageSize

Number of elements in the list, as defined in $top. Default is 10.

": "{Integer}",
43
          "position
Position

Position of the first element in the list

": "{Integer}",
44
          "page
Page

Page index

": "{Integer}",
45
          "firstPageKey
FirstPageKey

Page key to use for navigating to the first page in the list

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

": "{String}",
46
          "firstPage
FirstPage

Link to the first page in the list. $pageKey is set to FirstPageKey.

": "{String}",
47
          "previousPageKey
PreviousPageKey

Page key to use for navigating to previous page in the list

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

": "{String}",
48
          "previousPage
PreviousPage

Link to the previous page in the list. $pageKey is set to PreviousPageKey.

": "{String}",
49
          "nextPageKey
NextPageKey

Page key to use for navigating to next page in the list

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

": "{String}",
50
          "nextPage
NextPage

Link to the next page in the list. $pageKey is set to NextPageKey.

": "{String}",
51
          "lastPageKey
LastPageKey

Page key to use for navigating to last page in the list

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

": "{String}",
52
          "lastPage
LastPage

Link to the last page in the list. $pageKey is set to LastPageKey.

": "{String}",
53
          "size
Size

Total number of records in the list. Use $inlinecount=allpages in the request uri to include this

": "{Integer}"
54
     }
55
}

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