Application users

Retrieve an application instance

Retrieve a list of application instances. You may sort by the id, name, status, createdTime, and updatedTime.

Request
Security:
path Parameters
applicationId
required
string <= 50 characters ^[@~\-\.\w]+$

The application identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

An application instance was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/application-instances/{applicationId}
Request samples
$applicationInstance = $client->applicationInstances()->load('applicationId');
Response samples
application/json
{
  • "status": "enabling",
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Create or update an application instance

Create or update an application instance.

Request
Security:
path Parameters
applicationId
required
string <= 50 characters ^[@~\-\.\w]+$

The application identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Request Body schema: application/json
required
object
property name*
string
Responses
200

Application instance was updated.

201

Application instance was created.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

put/application-instances/{applicationId}
Request samples
application/json
{
  • "settings": {
    }
}
Response samples
application/json
{
  • "status": "enabling",
  • "settings": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}

Delete application instance

Delete application instance with predefined identifier string.

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

The application identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
204

Application instance was deleted.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

delete/application-instances/{applicationId}
Request samples
$client->applicationInstances()->delete('applicationId');
Response samples
application/json
{
  • "status": 400,
  • "title": "string",
  • "detail": "string",
  • "error": "string"
}

Retrieve a list of applications

Retrieve a list of applications. You may sort by the id, name, status, createdTime, and updatedTime.

Request
Security:
query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

filter
string

The collection items filter requires a special format. Use "," for multiple allowed values. Use ";" for multiple fields. See the filter guide for more options and examples about this format.

q
string

The partial search of the text fields.

expand
string

Expand a response to get a full related object included inside of the _embedded path in the response. It accepts a comma-separated list of objects to expand. See the expand guide for more info.

fields
string

Limit the returned fields to the list specified, separated by comma. Note that id is always returned.

sort
Array of strings

The collection items sort field and order (prefix with "-" for descending sort).

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

A list of applications was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/applications
Request samples
$applications = $client->applications()->search([
    'filter' => 'status:available',
]);
Response samples
application/json
[
  • {
    }
]

Retrieve application

Retrieve application with predefined identifier string.

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

The resource identifier string.

header Parameters
Organization-Id
string (ResourceId) <= 50 characters
Deprecated

Organization identifier in scope of which need to perform request (if not specified, the default organization will be used).

It is deprecated. Use servers with /organizations/{organizationId} base path instead.

Example: 4f6cf35x-2c4y-483z-a0a9-158621f77a21
Responses
200

Applications was retrieved successfully.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

get/applications/{id}
Request samples
$application = $client->applications()->load('applicationId');
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "name": "string",
  • "logoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "authorName": "string",
  • "authorLogoId": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "tagline": "string",
  • "description": "string",
  • "status": "pending-approval",
  • "permissions": [
    ],
  • "properties": {
    },
  • "createdTime": "2019-08-24T14:15:22Z",
  • "updatedTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ],
  • "_embedded": [
    ]
}