Spaces
Spaces are logical containers within your tenant and control access for users and groups through space roles to what content users can access.
Endpoints
- GET/v1/spaces
- POST/v1/spaces
- GET/v1/spaces/{spaceId}
- PATCH/v1/spaces/{spaceId}
- PUT/v1/spaces/{spaceId}
- DELETE/v1/spaces/{spaceId}
- GET/v1/spaces/{spaceId}/assignments
- POST/v1/spaces/{spaceId}/assignments
- GET/v1/spaces/{spaceId}/assignments/{assignmentId}
- PUT/v1/spaces/{spaceId}/assignments/{assignmentId}
- DELETE/v1/spaces/{spaceId}/assignments/{assignmentId}
- GET/v1/spaces/types
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Query Parameters
- actionstring
Action on space. Supports only "?action=publish".
- filterstring
Exact match filtering on space name using SCIM. Case insensitive on attribute name. For example ?filter=name eq "MySpace" and ?filter=NAME eq "MySpace" is both valid.
- limitinteger
Maximum number of spaces to return.
- namestring
Space name to search and filter for. Case-insensitive open search with wildcards both as prefix and suffix. For example, "?name=fin" will get "finance", "Final" and "Griffin".
- nextstring
The next page cursor. Next links make use of this.
- ownerIdstring
Space ownerId to filter by. For example, "?ownerId=123".
- prevstring
The previous page cursor. Previous links make use of this.
- sortstring
Field to sort by. Prefix with +/- to indicate asc/desc. For example, "?sort=+name" to sort ascending on Name. Supported fields are "type", "name" and "createdAt".
- typestring
Type(s) of space to filter. For example, "?type=managed,shared".
Responses
200
application/json
Spaces retrieved.
- application/jsonobject
application/json properties
- dataarray of objects
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
data properties
- idstringRequired
A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
- metaobject
Information about the space settings.
meta properties
- rolesarray of stringsRequired
The list of roles assigned to the current user in this space.
Values may be any of: "consumer""contributor""dataconsumer""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- actionsarray of stringsRequired
The list of actions allowed by the current user in this space.
Values may be any of: "create""read""update""delete""publish"
- assignableRolesarray of objectsRequired
-
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestring
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- assignmentsobjectRequired
assignments properties
- hrefstringRequired
URL that defines the resource.
-
-
- ownerIdstring
The ID for the space owner.
- tenantIdstringRequired
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the space.
- updatedAtstring
The date and time when the space was updated.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
- metaobject
meta properties
- countintegerRequired
The total number of spaces matching the current filter.
- personalSpaceobject
The meta related to personal space when applicable.
personalSpace properties
- actionsarray of objectsRequired
- resourceTypestringRequired
resource type
-
-
- linksobject
links properties
- nextobject
next properties
- hrefstringRequired
URL that defines the resource.
-
- prevobject
prev properties
- hrefstringRequired
URL that defines the resource.
-
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
-
-
400
application/json
Bad request
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space ls
Response
{
"data": [
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"meta": {
"roles": [
"consumer"
],
"actions": [
"create"
],
"assignableRoles": [
{}
]
},
"name": "string",
"type": "shared",
"links": {
"self": {
"href": "string"
},
"assignments": {
"href": "string"
}
},
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"description": "string"
}
],
"meta": {
"count": 42,
"personalSpace": {
"actions": [
{}
],
"resourceType": "string"
}
},
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Request Body
Requiredapplication/json
Attributes that the user wants to set for a new space.
- application/jsonobject
application/json properties
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestringRequired
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
Responses
201
application/json
Space created.
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- application/jsonobject
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
application/json properties
- idstringRequired
A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
- metaobject
Information about the space settings.
meta properties
- rolesarray of objectsRequired
- actionsarray of objectsRequired
- assignableRolesarray of objectsRequired
-
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestring
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- assignmentsobjectRequired
assignments properties
- hrefstringRequired
URL that defines the resource.
-
-
- ownerIdstring
The ID for the space owner.
- tenantIdstringRequired
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the space.
- updatedAtstring
The date and time when the space was updated.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Space create operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
409
application/json
Space already exists. name
must be unique.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","type":"shared","description":"string"}'
const https = require('https')
const data = JSON.stringify({"name":"string","type":"shared","description":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik space create \
--description="string" \
--name="string" \
--type="shared"
Request
{
"name": "string",
"type": "shared",
"description": "string"
}
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"meta": {
"roles": [
{}
],
"actions": [
{}
],
"assignableRoles": [
{}
]
},
"name": "string",
"type": "shared",
"links": {
"self": {
"href": "string"
},
"assignments": {
"href": "string"
}
},
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"description": "string"
}
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Path Parameters
- spaceIdstringRequired
The ID of the space to retrieve.
Responses
200
application/json
Space retrieved.
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- application/jsonobject
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
application/json properties
- idstringRequired
A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
- metaobject
Information about the space settings.
meta properties
- rolesarray of objectsRequired
- actionsarray of objectsRequired
- assignableRolesarray of objectsRequired
-
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestring
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- assignmentsobjectRequired
assignments properties
- hrefstringRequired
URL that defines the resource.
-
-
- ownerIdstring
The ID for the space owner.
- tenantIdstringRequired
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the space.
- updatedAtstring
The date and time when the space was updated.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
429
application/json
Too many repetetive requests.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space get <spaceId>
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"meta": {
"roles": [
{}
],
"actions": [
{}
],
"assignableRoles": [
{}
]
},
"name": "string",
"type": "shared",
"links": {
"self": {
"href": "string"
},
"assignments": {
"href": "string"
}
},
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"description": "string"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- spaceIdstringRequired
The ID of the space to update.
Request Body
Requiredapplication/json
Attribute that the user wants to patch (update) for the specified space.
A JSONPatch document as defined by RFC 6902.
- application/jsonarray of objects
A JSONPatch document as defined by RFC 6902.
application/json properties
- opstringRequired
The operation to be performed.
Can be one of: "replace"
- pathstringRequired
Field of space to be patched (updated).
Can be one of: "/name""/ownerId""/description"
- valuestringRequired
The value to be used within the operations.
- name: The name (string) of space of maxLength 256 of pattern: ^[^"*?<>/|\:]+$
- description: The description (string) of the space. Personal spaces do not have a description.
- ownerId: The user ID in uid format (string) of the space owner.
-
Responses
200
application/json
Space patched (updated).
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- application/jsonobject
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
application/json properties
- idstringRequired
A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
- metaobject
Information about the space settings.
meta properties
- rolesarray of objectsRequired
- actionsarray of objectsRequired
- assignableRolesarray of objectsRequired
-
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestring
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- assignmentsobjectRequired
assignments properties
- hrefstringRequired
URL that defines the resource.
-
-
- ownerIdstring
The ID for the space owner.
- tenantIdstringRequired
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the space.
- updatedAtstring
The date and time when the space was updated.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Space patch (update) operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '[{"op":"replace","path":"/name","value":"string"}]'
const https = require('https')
const data = JSON.stringify([{"op":"replace","path":"/name","value":"string"}])
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}',
'method': 'PATCH',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik space patch <spaceId> \
--body='[{"op":"replace","path":"/name","value":"string"}]'
Request
[
{
"op": "replace",
"path": "/name",
"value": "string"
}
]
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"meta": {
"roles": [
{}
],
"actions": [
{}
],
"assignableRoles": [
{}
]
},
"name": "string",
"type": "shared",
"links": {
"self": {
"href": "string"
},
"assignments": {
"href": "string"
}
},
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"description": "string"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- spaceIdstringRequired
The ID of the space to update.
Request Body
Requiredapplication/json
Attributes that the user wants to update for the specified space.
- application/jsonobject
application/json properties
- namestring
The name of the space.
- ownerIdstring
The user ID of the space owner.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
Responses
200
application/json
Space updated.
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
- application/jsonobject
A space is a security context simplifying the management of access control by allowing users to control it on the containers instead of on the resources themselves.
application/json properties
- idstringRequired
A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
- metaobject
Information about the space settings.
meta properties
- rolesarray of objectsRequired
- actionsarray of objectsRequired
- assignableRolesarray of objectsRequired
-
- namestringRequired
The name of the space. Personal spaces do not have a name.
- typestring
The type of space such as shared, managed, and so on.
Can be one of: "shared""managed""data"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- assignmentsobjectRequired
assignments properties
- hrefstringRequired
URL that defines the resource.
-
-
- ownerIdstring
The ID for the space owner.
- tenantIdstringRequired
The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the space.
- updatedAtstring
The date and time when the space was updated.
- descriptionstring
The description of the space. Personal spaces do not have a description.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Space update operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"name":"string","ownerId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","description":"string"}'
const https = require('https')
const data = JSON.stringify({"name":"string","ownerId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","description":"string"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik space update <spaceId> \
--description="string" \
--name="string" \
--ownerId="TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
Request
{
"name": "string",
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"description": "string"
}
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"meta": {
"roles": [
{}
],
"actions": [
{}
],
"assignableRoles": [
{}
]
},
"name": "string",
"type": "shared",
"links": {
"self": {
"href": "string"
},
"assignments": {
"href": "string"
}
},
"ownerId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"description": "string"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- spaceIdstringRequired
The ID of the space to delete.
Responses
204
Space deleted.
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Space delete operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
412
application/json
Space delete precondition (space not empty) failed.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space rm <spaceId>
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Query Parameters
- assigneeIdstring
Filters assignment for a specific assigneeid.
- limitinteger
Maximum number of assignments to return.
- nextstring
The next page cursor. Next links make use of this.
- prevstring
The previous page cursor. Previous links make use of this.
- typestring
The type of assignment. Supported values are user or group.
Can be one of: "user""group"
Path Parameters
- spaceIdstringRequired
The ID of the space of the assignment.
Responses
200
application/json
Assignments retrieved.
- application/jsonobject
application/json properties
- dataarray of objects
data properties
- idstringRequired
- typestringRequired
The type of assignment such as user or group
Can be one of: "user""group"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- spaceobject
space properties
- hrefstringRequired
URL that defines the resource.
-
-
- rolesarray of objectsRequired
- spaceIdstringRequired
The unique identifier for the space.
- tenantIdstringRequired
The unique identifier for the tenant.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the assignment.
- updatedAtstring
The date and time when the space was updated.
- updatedBystring
The ID of the user who updated the assignment.
- assigneeIdstringRequired
The userId or groupId based on the type.
-
- metaobject
meta properties
- countintegerRequired
The total number of assignments matching the current filter.
-
- linksobject
links properties
- nextobject
next properties
- hrefstringRequired
URL that defines the resource.
-
- prevobject
prev properties
- hrefstringRequired
URL that defines the resource.
-
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
-
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Assignments retrieve operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}/assignments',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space assignment ls \
--spaceId="string"
Response
{
"data": [
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"type": "user",
"links": {
"self": {
"href": "string"
},
"space": {
"href": "string"
}
},
"roles": [
{}
],
"spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
],
"meta": {
"count": 42
},
"links": {
"next": {
"href": "string"
},
"prev": {
"href": "string"
},
"self": {
"href": "string"
}
}
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- spaceIdstringRequired
The ID of the space of the assignment.
Request Body
Requiredapplication/json
Attributes that the user wants to set for the assignment for the space.
- application/jsonobject
application/json properties
- typestringRequired
The type of assignment such as user or group
Can be one of: "user""group"
- rolesarray of objectsRequired
- assigneeIdstringRequired
The userId or groupId based on the type.
-
Responses
201
application/json
Assignment created.
- application/jsonobject
application/json properties
- idstringRequired
- typestringRequired
The type of assignment such as user or group
Can be one of: "user""group"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- spaceobject
space properties
- hrefstringRequired
URL that defines the resource.
-
-
- rolesarray of objectsRequired
- spaceIdstringRequired
The unique identifier for the space.
- tenantIdstringRequired
The unique identifier for the tenant.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the assignment.
- updatedAtstring
The date and time when the space was updated.
- updatedBystring
The ID of the user who updated the assignment.
- assigneeIdstringRequired
The userId or groupId based on the type.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Assignment create operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
409
application/json
Assignment already exists. assigneeId
must be unique.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"type":"user","roles":[{}],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}'
const https = require('https')
const data = JSON.stringify({"type":"user","roles":[{}],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}/assignments',
'method': 'POST',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik space assignment create \
--assigneeId="TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69" \
--roles='{}' \
--spaceId="string" \
--type="user"
Request
{
"type": "user",
"roles": [
{}
],
"assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"type": "user",
"links": {
"self": {
"href": "string"
},
"space": {
"href": "string"
}
},
"roles": [
{}
],
"spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Path Parameters
- assignmentIdstringRequired
The ID of the assignment to retrieve.
- spaceIdstringRequired
The ID of the space of the assignment.
Responses
200
application/json
Assignment retrieved.
- application/jsonobject
application/json properties
- idstringRequired
- typestringRequired
The type of assignment such as user or group
Can be one of: "user""group"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- spaceobject
space properties
- hrefstringRequired
URL that defines the resource.
-
-
- rolesarray of objectsRequired
- spaceIdstringRequired
The unique identifier for the space.
- tenantIdstringRequired
The unique identifier for the tenant.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the assignment.
- updatedAtstring
The date and time when the space was updated.
- updatedBystring
The ID of the user who updated the assignment.
- assigneeIdstringRequired
The userId or groupId based on the type.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Assignment retrieve operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied or assignment not found.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}/assignments/{assignmentId}',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space assignment get <assignmentId> \
--spaceId="string"
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"type": "user",
"links": {
"self": {
"href": "string"
},
"space": {
"href": "string"
}
},
"roles": [
{}
],
"spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- assignmentIdstringRequired
The ID of the assignment to update.
- spaceIdstringRequired
The ID of the space of the assignment.
Request Body
Requiredapplication/json
Attributes that the user wants to update for the specified assignment.
- application/jsonobject
application/json properties
- rolesarray of objects
-
Responses
200
application/json
Assignment updated.
- application/jsonobject
application/json properties
- idstringRequired
- typestringRequired
The type of assignment such as user or group
Can be one of: "user""group"
- linksobjectRequired
links properties
- selfobjectRequired
self properties
- hrefstringRequired
URL that defines the resource.
-
- spaceobject
space properties
- hrefstringRequired
URL that defines the resource.
-
-
- rolesarray of objectsRequired
- spaceIdstringRequired
The unique identifier for the space.
- tenantIdstringRequired
The unique identifier for the tenant.
- createdAtstring
The date and time when the space was created.
- createdBystring
The ID of the user who created the assignment.
- updatedAtstring
The date and time when the space was updated.
- updatedBystring
The ID of the user who updated the assignment.
- assigneeIdstringRequired
The userId or groupId based on the type.
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Assignment update operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <API-key>" \
-d '{"roles":[{}]}'
const https = require('https')
const data = JSON.stringify({"roles":[{}]})
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}/assignments/{assignmentId}',
'method': 'PUT',
'headers': {
'Content-type': 'application/json',
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
req.write(data)
qlik space assignment update <assignmentId> \
--roles='{}' \
--spaceId="string"
Request
{
"roles": [
{}
]
}
Response
{
"id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"type": "user",
"links": {
"self": {
"href": "string"
},
"space": {
"href": "string"
}
},
"roles": [
{}
],
"spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"createdAt": "2018-10-30T07:06:22Z",
"createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"updatedAt": "2018-10-30T07:06:22Z",
"updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
"assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}
Facts
Rate limit | Tier 2 (100 requests per minute) |
Categories | manage |
Path Parameters
- assignmentIdstringRequired
The ID of the assignment to delete.
- spaceIdstringRequired
The ID of the space of the assignment.
Responses
204
Assignment deleted.
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
403
application/json
Assignment delete operation denied.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
404
application/json
Space not found or access denied or assignment not found.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X DELETE \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/{spaceId}/assignments/{assignmentId}',
'method': 'DELETE',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space assignment rm <assignmentId> \
--spaceId="string"
Facts
Rate limit | Tier 1 (1000 requests per minute) |
Categories | manage |
Responses
200
application/json
Space types retrieved.
The distinct types of spaces (shared, managed, and so on).
- application/jsonobject
The distinct types of spaces (shared, managed, and so on).
application/json properties
- dataarray of strings
The name of the type.
Values may be any of: "shared""managed""data"
-
401
application/json
Unauthorized, JWT invalid or not provided.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
500
application/json
Internal server error.
- application/jsonobject
application/json properties
- codestringDeprecated
The error code.
- metaobjectDeprecated
Additional properties relating to the error.
- titlestringDeprecated
Summary of the problem.
- detailstringDeprecated
A human-readable explanation specific to the occurrence of this problem.
- errorsarray of objects
- sourceobjectDeprecated
References to the source of the error.
source properties
- pointerstring
A JSON pointer to the property that caused the error.
- parameterstring
The URI query parameter that caused the error.
-
- traceIdstring
-
curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/types" \
-H "Authorization: Bearer <API-key>"
const https = require('https')
const data = JSON.stringify("")
const options = {
'hostname': 'https://your-tenant.us.qlikcloud.com',
'port': 443,
'path': '/api/v1/spaces/types',
'method': 'GET',
'headers': {
'Authorization': 'Bearer <API-key>'
}
}
const req = https.request(options)
qlik space types
Response
{
"data": [
"shared",
"managed"
]
}