UI

Gets list of user UI configurations

Returns list of user UI configurations

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

query Parameters
user
integer

Filter UI configurations by 'user' integer value.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/user-ui-config/
Response samples
application/json
{
  • "count": 0,
  • "next": "string",
  • "previous": "string",
  • "results": [
    ]
}

Create user UI configuration

Returns instance of created UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

Request Body schema: application/json
object
user
integer
Responses
201

Successful Operation

400

Bad request

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

500

Internal server error

post/api/v1/enterprise/{enterprise_id}/user-ui-config/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Get instance of user UI configuration

Returns instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Responses
200

successful operation

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

get/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Updates instance of user UI configuration

Returns updated instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Request Body schema: application/json
object
user
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

put/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Partially updates user UI configuration

Returns instance of user UI configuration

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Request Body schema: application/json
object
user
integer
Responses
200

successful operation

400

Invalid request.

401

Authorization information is missing or invalid.

404

Not Found.

500

Internal server error

patch/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Request samples
application/json
{
  • "features": {
    },
  • "user": 0
}
Response samples
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "features": {
    },
  • "created_on": "2019-08-24T14:15:22Z",
  • "user": 0
}

Deletes instance of user UI configuration

Empty response

SecurityapiKey
Request
path Parameters
enterprise_id
required
string

A UUID string identifying this enterprise.

userui_id
required
string

A UUID string identifying the user UI configuration.

Responses
204

The resource was deleted successfully.

400

Invalid request.

401

Authorization information is missing or invalid.

403

Forbidden, no permission to perform this action.

404

Not Found.

500

Internal server error

delete/api/v1/enterprise/{enterprise_id}/user-ui-config/{userui_id}/
Response samples
application/json
{
  • "errors": [
    ],
  • "message": "string",
  • "status": 0
}