Tenant API (v2)

postTenant

Start tenant operation

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Request Body schema: application/json
module_from
string

Existing module ID. If omitted, the module is not enabled already

module_to
string

Target module ID. If omitted, the existing module is disabled.

purge
boolean

On disable should data also be purged

Array of objects

Parameters that controls what tenant init (eg reference data)

Responses

Request samples

Content type
application/json
{
  • "module_to": "module-1.1",
  • "module_from": "module-1.0",
  • "parameters": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant": "string",
  • "tenantAttributes": {
    },
  • "complete": true,
  • "error": "string",
  • "messages": [
    ]
}

getTenantJob

Get tenant job

path Parameters
id
required
string <uuid>

job identifier

query Parameters
wait
integer

wait until job change, but no longer than the wait time - in milliseconds. 0 means "no wait" and is behavior if omitted.

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
application/json
{
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "tenant": "string",
  • "tenantAttributes": {
    },
  • "complete": true,
  • "error": "string",
  • "messages": [
    ]
}

deleteTenantJob

delete tenant job

path Parameters
id
required
string <uuid>

job identifier

header Parameters
X-Okapi-Tenant
string

Okapi Tenant

X-Okapi-Token
string

Okapi Token

X-Okapi-Url
string

Okapi URL

Responses

Response samples

Content type
No sample