Spaces

Spaces are logical containers within your tenant and control access for users and groups through space roles to what content users can access.

Download specification

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/{spaceId}/shares
POST

/v1/spaces/{spaceId}/shares
GET

/v1/spaces/{spaceId}/shares/{shareId}
PATCH

/v1/spaces/{spaceId}/shares/{shareId}
DELETE

/v1/spaces/{spaceId}/shares/{shareId}
GET

/v1/spaces/types

Retrieves spaces that the current user has access to and match the query.

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.

default = 10, format = int32, default = 10
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
Show 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.
  
  Show data properties
  
  idstring
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
  
  metaobject
  
  Information about the space settings.
  
  Show meta properties
  
  rolesarray of strings
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  assignableRolesarray of strings
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  namestring
  Required
  
  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"
  
  linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  assignmentsobject
  Required
  
  Show assignments properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  ownerIdstring
  
  The ID for the space owner.
  
  format = "uid"
  
  tenantIdstring
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
  
  createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
  
  createdBystring
  
  The ID of the user who created the space.
  
  format = "uid"
  
  updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
  
  descriptionstring
  
  The description of the space. Personal spaces do not have a description.
- metaobject
  
  Show meta properties
  
  countinteger
  Required
  
  The total number of spaces matching the current filter.
  
  personalSpaceobject
  
  The meta related to personal space when applicable.
  
  Show personalSpace properties
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  resourceTypestring
  Required
  
  resource type
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.

400

application/json

Bad request

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces" \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  const req = https.request(options)

qlik space ls

Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "meta": {
        "roles": [
          "consumer"
        ],
        "actions": [
          "change_owner"
        ],
        "assignableRoles": [
          "consumer"
        ]
      },
      "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": [
        "change_owner"
      ],
      "resourceType": "string"
    }
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a space. Spaces names must be unique. Spaces of type data should only be used for Qlik Talend Data Integration projects.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Request Body

Required

application/json

Attributes that the user wants to set for a new space.

application/jsonobject
Show application/json properties
- namestring
  Required
  
  The name of the space. Personal spaces do not have a name.
  
  maxLength = 256, pattern = "^[^\"\*\?\<\>\/\|\\\:]+$"
- typestring
  Required
  
  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.
Show application/json properties
- idstring
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- metaobject
  
  Information about the space settings.
  
  Show meta properties
  
  rolesarray of strings
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  assignableRolesarray of strings
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- namestring
  Required
  
  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"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  assignmentsobject
  Required
  
  Show assignments properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- ownerIdstring
  
  The ID for the space owner.
  
  format = "uid"
- tenantIdstring
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- descriptionstring
  
  The description of the space. Personal spaces do not have a description.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

POST /v1/spaces

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"name":"Finance (dev)","type":"shared","description":"Development space for users building apps for the Finance team."}'

const https = require('https')
  const data = JSON.stringify({"name":"Finance (dev)","type":"shared","description":"Development space for users building apps for the Finance team."})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik space create \
--description="Development space for users building apps for the Finance team." \
--name="Finance (dev)" \
--type="shared"

Request

{
  "name": "Finance (dev)",
  "type": "shared",
  "description": "Development space for users building apps for the Finance team."
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "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"
}

Retrieves a single space by ID.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space to retrieve.

format = "uid"

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.
Show application/json properties
- idstring
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- metaobject
  
  Information about the space settings.
  
  Show meta properties
  
  rolesarray of strings
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  assignableRolesarray of strings
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- namestring
  Required
  
  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"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  assignmentsobject
  Required
  
  Show assignments properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- ownerIdstring
  
  The ID for the space owner.
  
  format = "uid"
- tenantIdstring
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- descriptionstring
  
  The description of the space. Personal spaces do not have a description.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/{spaceId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  const req = https.request(options)

qlik space get <spaceId>

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "meta": {
    "roles": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "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"
}

Updates one or more properties of a space. To update all properties at once, use PUT /spaces/{spaceId}.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space to update.

format = "uid"

Request Body

Required

application/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.
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  Field of space to be patched (updated).
  
  Can be one of: "/name""/ownerId""/description"
- valuestring
  Required
  
  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.
Show application/json properties
- idstring
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- metaobject
  
  Information about the space settings.
  
  Show meta properties
  
  rolesarray of strings
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  assignableRolesarray of strings
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- namestring
  Required
  
  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"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  assignmentsobject
  Required
  
  Show assignments properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- ownerIdstring
  
  The ID for the space owner.
  
  format = "uid"
- tenantIdstring
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- descriptionstring
  
  The description of the space. Personal spaces do not have a description.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

PATCH /v1/spaces/{spaceId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-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 <access_token>'
    }
  }
  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": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "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"
}

Updates a space. To update specific properties, use PATCH /spaces/{spaceId}.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space to update.

format = "uid"

Request Body

Required

application/json

Attributes that the user wants to update for the specified space.

application/jsonobject
Show application/json properties
- namestring
  
  The name of the space.
  
  maxLength = 256, pattern = "^[^\"\*\?\<\>\/\|\\\:]+$"
- ownerIdstring
  
  The user ID of the space owner.
  
  format = "uid"
- 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.
Show application/json properties
- idstring
  Required
  
  A unique identifier for the space, for example, 62716f4b39b865ece543cd45.
  
  format = "uid"
- metaobject
  
  Information about the space settings.
  
  Show meta properties
  
  rolesarray of strings
  Required
  
  The list of roles assigned to the current user in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  actionsarray of strings
  Required
  
  The list of actions allowed by the current user in this space.
  
  Values may be any of: "change_owner""create""read""update""delete""publish""link_environment"
  
  assignableRolesarray of strings
  Required
  
  The list of roles that could be assigned in this space.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- namestring
  Required
  
  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"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  assignmentsobject
  Required
  
  Show assignments properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- ownerIdstring
  
  The ID for the space owner.
  
  format = "uid"
- tenantIdstring
  Required
  
  The ID for the tenant, for example, xqGQ0k66vSR8f9G7J-vYtHZQkiYrCpct.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the space.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- descriptionstring
  
  The description of the space. Personal spaces do not have a description.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

PUT /v1/spaces/{spaceId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-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 <access_token>'
    }
  }
  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": [
      "consumer"
    ],
    "actions": [
      "change_owner"
    ],
    "assignableRoles": [
      "consumer"
    ]
  },
  "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"
}

Deletes a space. Ensure that you first delete all resources from the space to avoid orphaning content.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space to delete.

format = "uid"

Responses

204

Space deleted.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

DELETE /v1/spaces/{spaceId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  const req = https.request(options)

qlik space rm <spaceId>

Retrieves the assignments of the space matching the query. Each assignment represents one user or group and their corresponding roles in the space. Assignments are not shown for the owner of a space, who receive all assignableRoles by default.

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.

default = 10, format = int32, default = 10
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

spaceIdstring
Required

The ID of the space of the assignment.

format = "uid"

Responses

200

application/json

Assignments retrieved.

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  format = "uid"
  
  typestring
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group"
  
  linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  rolesarray of strings
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
  
  spaceIdstring
  Required
  
  The unique identifier for the space.
  
  format = "uid"
  
  tenantIdstring
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
  
  createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
  
  createdBystring
  
  The ID of the user who created the assignment.
  
  format = "uid"
  
  updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
  
  updatedBystring
  
  The ID of the user who updated the assignment.
  
  format = "uid"
  
  assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- metaobject
  
  Show meta properties
  
  countinteger
  Required
  
  The total number of assignments matching the current filter.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/{spaceId}/assignments

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  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": [
        "consumer"
      ],
      "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"
    }
  }
}

Creates an assignment for a user or group (assignee) to a space with the specified roles. Assignments are not required for space owners, who receive all assignableRoles by default. Only one assignment can exist per space, per user or group.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space of the assignment.

format = "uid"

Request Body

Required

application/json

Attributes that the user wants to set for the assignment for the space.

application/jsonobject
Show application/json properties
- typestring
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group"
- rolesarray of strings
  Required
  
  The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call GET /spaces/{spaceId} and inspect the meta.assignableRoles object.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

Responses

201

application/json

Assignment created.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of strings
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceIdstring
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantIdstring
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

POST /v1/spaces/{spaceId}/assignments

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"user","roles":["consumer"],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}'

const https = require('https')
  const data = JSON.stringify({"type":"user","roles":["consumer"],"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 <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik space assignment create \
--assigneeId="TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69" \
--roles='"consumer"' \
--spaceId="string" \
--type="user"

Request

{
  "type": "user",
  "roles": [
    "consumer"
  ],
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Retrieves a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

assignmentIdstring
Required

The ID of the assignment to retrieve.

format = "uid"
spaceIdstring
Required

The ID of the space of the assignment.

format = "uid"

Responses

200

application/json

Assignment retrieved.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of strings
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceIdstring
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantIdstring
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/{spaceId}/assignments/{assignmentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  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": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Updates a single assignment by assignment ID. Use GET /spaces/{spaceId}/assignments to list all users and groups assigned to the space and their assignment ID. The complete list of roles must be provided.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

assignmentIdstring
Required

The ID of the assignment to update.

format = "uid"
spaceIdstring
Required

The ID of the space of the assignment.

format = "uid"

Request Body

Required

application/json

Attributes that the user wants to update for the specified assignment.

application/jsonobject
Show application/json properties
- rolesarray of strings
  
  The roles assigned to the assigneeId. For the full list of roles assignable in this space type, call GET /spaces/{spaceId} and inspect the meta.assignableRoles object.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"

Responses

200

application/json

Assignment updated.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  The type of assignment such as user or group
  
  Can be one of: "user""group"
- linksobject
  Required
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of strings
  Required
  
  The roles assigned to a user or group. Must not be empty.
  
  Values may be any of: "consumer""contributor""dataconsumer""datapreview""facilitator""operator""producer""publisher""basicconsumer""codeveloper"
- spaceIdstring
  Required
  
  The unique identifier for the space.
  
  format = "uid"
- tenantIdstring
  Required
  
  The unique identifier for the tenant.
  
  format = "uid"
- createdAtstring
  
  The date and time when the space was created.
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the assignment.
  
  format = "uid"
- updatedAtstring
  
  The date and time when the space was updated.
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the assignment.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

PUT /v1/spaces/{spaceId}/assignments/{assignmentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X PUT \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"roles":["consumer"]}'

const https = require('https')
  const data = JSON.stringify({"roles":["consumer"]})
  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 <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

qlik space assignment update <assignmentId> \
--roles='"consumer"' \
--spaceId="string"

Request

{
  "roles": [
    "consumer"
  ]
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    "consumer"
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Deletes an assignment.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

assignmentIdstring
Required

The ID of the assignment to delete.

format = "uid"
spaceIdstring
Required

The ID of the space of the assignment.

format = "uid"

Responses

204

Assignment deleted.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

DELETE /v1/spaces/{spaceId}/assignments/{assignmentId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/assignments/{assignmentId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  const req = https.request(options)

qlik space assignment rm <assignmentId> \
--spaceId="string"

Retrieves the shares of the space matching the query.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Query Parameters

groupIdstring

The ID of the group to which the resource is shared.
limitinteger

Maximum number of shares to return.

default = 10, format = int32, default = 10
namestring

The name of the shared resource.
nextstring

The next page cursor. Next links make use of this.
prevstring

The previous page cursor. Previous links make use of this.
resourceIdstring

The ID of the shared resource.
resourceTypestring

The type of the shared resource.
typestring

The type of share. user shares assign to a specific user, group shares assign to a specific group, and link shares provide anonymous access to a resource.

Can be one of: "user""group""link"
userIdstring

The ID of the user to which the resource is shared.

Path Parameters

spaceIdstring
Required

The ID of the space containing the shares.

format = "uid"

Responses

200

application/json

Shares retrieved.

application/jsonobject
Show application/json properties
- dataarray of objects
  
  Show data properties
  
  idstring
  Required
  
  format = "uid"
  
  typestring
  Required
  
  Can be one of: "user""group""link"
  
  linksobject
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  rolesarray of undefineds
  
  The roles assigned to the assigneeId.
  
  spaceIdstring
  Required
  
  format = "uid"
  
  disabledboolean
  
  If the share is disabled (effective ONLY for link shares).
  
  tenantIdstring
  Required
  
  format = "uid"
  
  createdAtstring
  
  format = "date-time"
  
  createdBystring
  
  The ID of the user who created the share.
  
  format = "uid"
  
  updatedAtstring
  
  format = "date-time"
  
  updatedBystring
  
  The ID of the user who updated the share.
  
  format = "uid"
  
  assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
  
  resourceIdstring
  Required
  
  The ID of the shared resource.
  
  format = "uid"
  
  resourceNamestring
  
  The name of the shared resource.
  
  maxLength = 256
  
  resourceTypestring
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"
- metaobject
  
  Show meta properties
  
  countinteger
  Required
  
  The total number of Shares matching the current filter.
- linksobject
  
  Show links properties
  
  nextobject
  
  Show next properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  prevobject
  
  Show prev properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Shares retrieve operation denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/{spaceId}/shares

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/shares" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces/{spaceId}/shares',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "data": [
    {
      "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "type": "user",
      "links": {
        "self": {
          "href": "string"
        },
        "space": {
          "href": "string"
        }
      },
      "roles": [
        null
      ],
      "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "disabled": true,
      "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "createdAt": "2018-10-30T07:06:22Z",
      "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "updatedAt": "2018-10-30T07:06:22Z",
      "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
      "resourceName": "string",
      "resourceType": "app"
    }
  ],
  "meta": {
    "count": 42
  },
  "links": {
    "next": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "self": {
      "href": "string"
    }
  }
}

Creates a share.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

spaceIdstring
Required

The ID of the space of the share.

format = "uid"

Request Body

Required

application/json

application/jsonobject
Show application/json properties
- typestring
  Required
  
  Can be one of: "user""group""link"
- rolesarray of undefineds
  Required
  
  The roles assigned to the assigneeId.
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceIdstring
  Required
  
  The resource id for the shared item.
  
  format = "uid"
- resourceTypestring
  Required
  
  The resource type for the shared item.
  
  format = "uid"

Responses

201

application/json

Share created.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  Can be one of: "user""group""link"
- linksobject
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of undefineds
  
  The roles assigned to the assigneeId.
- spaceIdstring
  Required
  
  format = "uid"
- disabledboolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantIdstring
  Required
  
  format = "uid"
- createdAtstring
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAtstring
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceIdstring
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceNamestring
  
  The name of the shared resource.
  
  maxLength = 256
- resourceTypestring
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Share create operation denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Share already exists. assigneeId must be unique.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

POST /v1/spaces/{spaceId}/shares

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/shares" \
-X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '{"type":"user","roles":[null],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceType":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"}'

const https = require('https')
  const data = JSON.stringify({"type":"user","roles":[null],"assigneeId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceId":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69","resourceType":"TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"})
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces/{spaceId}/shares',
    'method': 'POST',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

{
  "type": "user",
  "roles": [
    null
  ],
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceType": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69"
}

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    null
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Retrieves a single space share by ID.

Facts

Rate limit	Tier 1 (1000 requests per minute)
Categories	manage

Path Parameters

shareIdstring
Required

The ID of the share to retrieve.

format = "uid"
spaceIdstring
Required

The ID of the space to which the share belongs.

format = "uid"

Responses

200

application/json

Share retrieved.

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  Can be one of: "user""group""link"
- linksobject
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of undefineds
  
  The roles assigned to the assigneeId.
- spaceIdstring
  Required
  
  format = "uid"
- disabledboolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantIdstring
  Required
  
  format = "uid"
- createdAtstring
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAtstring
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceIdstring
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceNamestring
  
  The name of the shared resource.
  
  maxLength = 256
- resourceTypestring
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Share retrieve operation denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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 share not found.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/{spaceId}/shares/{shareId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces/{spaceId}/shares/{shareId}',
    'method': 'GET',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    null
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Updates properties of a space share (roles, and disabled state for link shares).

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

shareIdstring
Required

The ID of the share to update.

format = "uid"
spaceIdstring
Required

The ID of the space to which the share belongs.

format = "uid"

Request Body

Required

application/json

A JSONPatch document as defined by RFC 6902

application/jsonarray of objects

A JSONPatch document as defined by RFC 6902
Show application/json properties
- opstring
  Required
  
  The operation to be performed.
  
  Can be one of: "replace"
- pathstring
  Required
  
  Field of Share to be patched (updated).
  
  Can be one of: "/roles""/disabled"
- valuestring
  Required
  
  The value to be used within the operations.
  
  roles: The roles assigned to the assigneeId.
  
  disabled: To disable the share (effective ONLY for link shares).

Responses

200

application/json

Share patched (updated).

application/jsonobject
Show application/json properties
- idstring
  Required
  
  format = "uid"
- typestring
  Required
  
  Can be one of: "user""group""link"
- linksobject
  
  Show links properties
  
  selfobject
  Required
  
  Show self properties
  
  hrefstring
  Required
  
  URL that defines the resource.
  
  spaceobject
  
  Show space properties
  
  hrefstring
  Required
  
  URL that defines the resource.
- rolesarray of undefineds
  
  The roles assigned to the assigneeId.
- spaceIdstring
  Required
  
  format = "uid"
- disabledboolean
  
  If the share is disabled (effective ONLY for link shares).
- tenantIdstring
  Required
  
  format = "uid"
- createdAtstring
  
  format = "date-time"
- createdBystring
  
  The ID of the user who created the share.
  
  format = "uid"
- updatedAtstring
  
  format = "date-time"
- updatedBystring
  
  The ID of the user who updated the share.
  
  format = "uid"
- assigneeIdstring
  Required
  
  The userId or groupId based on the type.
  
  format = "uid"
- resourceIdstring
  Required
  
  The ID of the shared resource.
  
  format = "uid"
- resourceNamestring
  
  The name of the shared resource.
  
  maxLength = 256
- resourceTypestring
  Required
  
  The type of the shared resource.
  
  Can be one of: "app"

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Share patch (update) operation denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

Share not found or access denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

PATCH /v1/spaces/{spaceId}/shares/{shareId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-X PATCH \
-H "Content-type: application/json" \
-H "Authorization: Bearer <access_token>" \
-d '[{"op":"replace","path":"/roles","value":"string"}]'

const https = require('https')
  const data = JSON.stringify([{"op":"replace","path":"/roles","value":"string"}])
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces/{spaceId}/shares/{shareId}',
    'method': 'PATCH',
    'headers': {
      'Content-type': 'application/json',
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)
  req.write(data)

This API is not included yet in qlik-cli

Request

[
  {
    "op": "replace",
    "path": "/roles",
    "value": "string"
  }
]

Response

{
  "id": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "type": "user",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  },
  "roles": [
    null
  ],
  "spaceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "disabled": true,
  "tenantId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "createdAt": "2018-10-30T07:06:22Z",
  "createdBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "updatedAt": "2018-10-30T07:06:22Z",
  "updatedBy": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "assigneeId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceId": "TiQ8GPVr8qI714Lp5ChAAFFaU24MJy69",
  "resourceName": "string",
  "resourceType": "app"
}

Deletes a space share.

Facts

Rate limit	Tier 2 (100 requests per minute)
Categories	manage

Path Parameters

shareIdstring
Required

The ID of the share to delete.

format = "uid"
spaceIdstring
Required

The ID of the space to which the share belongs.

format = "uid"

Responses

204

Share deleted.

401

application/json

Unauthorized, JWT invalid or not provided.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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

share delete operation denied.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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 share not found.

application/jsonobject
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

DELETE /v1/spaces/{spaceId}/shares/{shareId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}/shares/{shareId}" \
-X DELETE \
-H "Authorization: Bearer <access_token>"

const https = require('https')
  const data = JSON.stringify("")
  const options =   {
    'hostname': 'https://your-tenant.us.qlikcloud.com',
    'port': 443,
    'path': '/api/v1/spaces/{spaceId}/shares/{shareId}',
    'method': 'DELETE',
    'headers': {
      'Authorization': 'Bearer <access_token>'
    }
  }
  const req = https.request(options)

This API is not included yet in qlik-cli

Gets a list of distinct space types available for use in the tenant.

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).
Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show 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
Show 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
  
  An error object.
  
  Show errors properties
  
  codestring
  Required
  
  The error code.
  
  metaobject
  
  Additional properties relating to the error.
  
  Show meta properties
  
  sourceobject
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
  
  titlestring
  Required
  
  Summary of the problem.
  
  detailstring
  
  A human-readable explanation specific to the occurrence of this problem.
- sourceobjectDeprecated
  
  References to the source of the error.
  
  Show source properties
  
  pointerstring
  
  A JSON pointer to the property that caused the error.
  
  parameterstring
  
  The URI query parameter that caused the error.
- traceIdstring

GET /v1/spaces/types

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/types" \
-H "Authorization: Bearer <access_token>"

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 <access_token>'
    }
  }
  const req = https.request(options)

qlik space types

Response

{
  "data": [
    "data",
    "shared",
    "managed"
  ]
}

Spaces

Endpoints

List spaces

Facts

Query Parameters

Responses

200

400

401

500

Response

Create a space

Facts

Request Body

Responses

201

401

403

409

500

Request

Response

Retrieve a space

Facts

Path Parameters

Responses

200

401

404

429

500

Response

Update a space's properties

Facts

Path Parameters

Request Body

Responses

200

401

403

404

500

Request

Response

Update a space

Facts

Path Parameters

Request Body

Responses

200

401

403

404

500

Request

Response

Delete a space

Facts

Path Parameters

Responses

204

401

403

404

412

500

List assignments for a space

Facts

Query Parameters

Path Parameters

Responses

200

401

403

404

500

Response

Assign a user or group to a space

Facts

Path Parameters