Retrieve an application instance

Retrieves an application instance with specified application and organization identifier strings.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

Resource identifier string.

organizationId
required
string <= 50 characters ^[@~\-\.\w]+$

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

Responses
200

Application instance retrieved.

Response Headers
Pagination-Total
integer

Total number of items.

Example: 332
Pagination-Limit
integer

Maximum number of items per page.

Example: 100
Pagination-Offset
integer

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example: 2
Response Schema: application/json
required
object

Settings that are available for the user to complete when they install the application. Use this object to describe fields that are rendered during installation, in the settings form.

property name*
additional property
string
status
string

Status of the application instance.

Enum: "enabling" "enabled" "disabling" "disabled"
createdTime
string <date-time> (CreatedTime)

Date and time which is set automatically when the resource is created.

updatedTime
string <date-time> (UpdatedTime)

Date and time which updates automatically when the resource is updated.

Array of Self (object) non-empty

Related resource links.

Array (non-empty)
Any of:
href
required
string

Link URL.

rel
required
string

Type of link.

Value: "self"
organizationId
string <= 50 characters

Unique organization identifier. An organization is an entity that represents a company. For more information, see Obtain an organization ID.

token
string

Session token used to authenticate an organization.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/applications/{id}/instances/{organizationId}
Request samples
$applicationInstance = $client->applications()->loadInstance('applicationId', 'organizationId');
Response samples
application/json
{
  • "status": "enabling",
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "organizationId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "token": "string"
}