System APIs
Update an application version
| HTTP method | PUT |
| URI | https://api.rambase.net/system/applications/{applicationId}/versions/{applicationVersionId} |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {applicationId} |
Application version identifier
Integer |
| - URI parameter {applicationVersionId} |
Unique identifier for an application version
Integer |
| Successful HTTP status code | 200 |
| API resource identifier | 2579, 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.
ApplicationVersion
This field is optional.
>Type
Type of HTML5 component. Used for widgets.
Applicable domain values can be found here
This field is optional.
>{String}</Type>Name
Name of application
This field is optional.
>{String}</Name>DescriptiveName
Descriptive name of the application
This field is optional.
>{String}</DescriptiveName>Description
The descriptive tag of an application or component
This field is optional.
>{String}</Description>Namespace
Namespace of the Application
This field is optional.
>{String}</Namespace>ContentType
Content Type
Applicable domain values can be found here
This field is optional.
>{String}</ContentType>ChangeDescription
Version description.
This field is optional.
>{String}</ChangeDescription>LookupKey
Matching Keyword
This field is optional.
>{String}</LookupKey>LookupPriority
The priority of whitch the application lookup will select applications with the same applicationmatch.
This field is optional.
>{Integer}</LookupPriority>Permission
Permission to use this application
This field is optional.
>PermissionId
Permission identifier
This field is optional.
>{Integer}</PermissionId>RedirectToApplication
This field is optional.
>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)
This field is optional.
>{Integer}</ApplicationId>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.
This field is optional.
>FieldOrder
A json structure describing the field order
This field is optional.
>{String}</FieldOrder>ApplicationVersion
This field is optional.
": {Type
Type of HTML5 component. Used for widgets.
Applicable domain values can be found here
This field is optional.
": "{String}",Name
Name of application
This field is optional.
": "{String}",DescriptiveName
Descriptive name of the application
This field is optional.
": "{String}",Description
The descriptive tag of an application or component
This field is optional.
": "{String}",Namespace
Namespace of the Application
This field is optional.
": "{String}",ContentType
Content Type
Applicable domain values can be found here
This field is optional.
": "{String}",ChangeDescription
Version description.
This field is optional.
": "{String}",LookupKey
Matching Keyword
This field is optional.
": "{String}",LookupPriority
The priority of whitch the application lookup will select applications with the same applicationmatch.
This field is optional.
": "{Integer}",Permission
Permission to use this application
This field is optional.
": {PermissionId
Permission identifier
This field is optional.
": "{Integer}"RedirectToApplication
This field is optional.
": {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)
This field is optional.
": "{Integer}"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.
This field is optional.
": {FieldOrder
A json structure describing the field order
This field is optional.
": "{String}"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.
| $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 |
| $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. |
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.
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 |
| Error 102870 HTTP 400 | Application must be in edit status (1) to update |