Skip to content

Spaces

Spaces is a central concept in the Qlik platform and is used to control access to various other resources in the system.

Endpoints

Skip to section
POST/spaces
GET/spaces
GET/spaces/{spaceId}
PUT/spaces/{spaceId}
PATCH/spaces/{spaceId}
DELETE/spaces/{spaceId}
POST/spaces/{spaceId}/assignments
GET/spaces/{spaceId}/assignments
GET/spaces/{spaceId}/assignments/{assignmentId}
PUT/spaces/{spaceId}/assignments/{assignmentId}
DELETE/spaces/{spaceId}/assignments/{assignmentId}
POST/spaces/{spaceId}/shares
GET/spaces/{spaceId}/shares
GET/spaces/{spaceId}/shares/{shareId}
PATCH/spaces/{spaceId}/shares/{shareId}
DELETE/spaces/{spaceId}/shares/{shareId}
GET/spaces/types
POST/spaces/filter

Creates a space

Request Body POST /spaces

application/json

No description

Responses POST /spaces

201
application/json

Space created.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Space create operation denied.

409
application/json

Space already exists. name must be unique.

500
application/json

Internal server error.

POST/spaces

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","description":"string","type":"shared"}'

Request POST /spaces

{
  "name": "string",
  "description": "string",
  "type": "shared"
}

Response POST /spaces

{
  "id": "string",
  "type": "shared",
  "ownerId": "string",
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2022-05-18T10:58:17.077Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.077Z",
  "meta": {
    "actions": [],
    "roles": [],
    "assignableRoles": {
      "description": "The supported roles for Shared spaces.",
      "type": "string",
      "enum": [
        "facilitator",
        "consumer",
        "producer",
        "dataconsumer"
      ],
      "dereferenced": "#/definitions/SharedSpaceRoleType"
    }
  },
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  }
}

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

Query Parameters GET /spaces

type
optional
string

Type(s) of space to filter. For example, "?type=managed,shared".

action
optional
string

Action on space. For example, "?action=publish".

sort
optional
string

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".

name
optional
string

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".

ownerId
optional
string

Space ownerId to filter by. For example, "?ownerId=123".

limit
optional, default=10
integer<int32>

Max number of spaces to return.

next
optional
string

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

prev
optional
string

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

Responses GET /spaces

200
application/json

Spaces retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

500
application/json

Internal server error.

GET/spaces

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

Response GET /spaces

{
  "data": [
    {
      "id": "string",
      "type": "shared",
      "ownerId": "string",
      "tenantId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "2022-05-18T10:58:17.077Z",
      "createdBy": "string",
      "updatedAt": "2022-05-18T10:58:17.077Z",
      "meta": {
        "actions": [],
        "roles": [],
        "assignableRoles": {
          "description": "The supported roles for Shared spaces.",
          "type": "string",
          "enum": [
            "facilitator",
            "consumer",
            "producer",
            "dataconsumer"
          ],
          "dereferenced": "#/definitions/SharedSpaceRoleType"
        }
      },
      "links": {
        "self": {
          "href": "string"
        },
        "assignments": {
          "href": "string"
        }
      }
    }
  ],
  "meta": {
    "count": 0
  },
  "links": {
    "self": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "next": {
      "href": "string"
    }
  }
}

Retrieves a single space by ID.

Path Parameters GET /spaces/{spaceId}

spaceId
string<uid>

The ID of the space to retrieve.

Responses GET /spaces/{spaceId}

200
application/json

Space retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

404
application/json

Space not found or access denied.

429
application/json

Too many repetetive requests.

500
application/json

Internal server error.

GET/spaces/{spaceId}

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

Response GET /spaces/{spaceId}

{
  "id": "string",
  "type": "shared",
  "ownerId": "string",
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2022-05-18T10:58:17.077Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.077Z",
  "meta": {
    "actions": [],
    "roles": [],
    "assignableRoles": {
      "description": "The supported roles for Shared spaces.",
      "type": "string",
      "enum": [
        "facilitator",
        "consumer",
        "producer",
        "dataconsumer"
      ],
      "dereferenced": "#/definitions/SharedSpaceRoleType"
    }
  },
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  }
}

Updates a space.

experimental

Path Parameters PUT /spaces/{spaceId}

spaceId
string<uid>

The ID of the space to update.

Request Body PUT /spaces/{spaceId}

application/json

No description

Responses PUT /spaces/{spaceId}

200
application/json

Space updated.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Space update operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

PUT/spaces/{spaceId}

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/{spaceId}" \
 -X PUT \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"name":"string","description":"string","ownerId":"string"}'

Request PUT /spaces/{spaceId}

{
  "name": "string",
  "description": "string",
  "ownerId": "string"
}

Response PUT /spaces/{spaceId}

{
  "id": "string",
  "type": "shared",
  "ownerId": "string",
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2022-05-18T10:58:17.077Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.077Z",
  "meta": {
    "actions": [],
    "roles": [],
    "assignableRoles": {
      "description": "The supported roles for Shared spaces.",
      "type": "string",
      "enum": [
        "facilitator",
        "consumer",
        "producer",
        "dataconsumer"
      ],
      "dereferenced": "#/definitions/SharedSpaceRoleType"
    }
  },
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  }
}

Patches (updates) a space (partially).

experimental

Path Parameters PATCH /spaces/{spaceId}

spaceId
string<uid>

The ID of the space to update.

Request Body PATCH /spaces/{spaceId}

application/json

No description

Responses PATCH /spaces/{spaceId}

200
application/json

Space patched (updated).

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Space patch (update) operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

PATCH/spaces/{spaceId}

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

Request PATCH /spaces/{spaceId}

{
  "op": "replace",
  "path": "/name",
  "value": "string"
}

Response PATCH /spaces/{spaceId}

{
  "id": "string",
  "type": "shared",
  "ownerId": "string",
  "tenantId": "string",
  "name": "string",
  "description": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.078Z",
  "meta": {
    "actions": [],
    "roles": [],
    "assignableRoles": {
      "description": "The supported roles for Shared spaces.",
      "type": "string",
      "enum": [
        "facilitator",
        "consumer",
        "producer",
        "dataconsumer"
      ],
      "dereferenced": "#/definitions/SharedSpaceRoleType"
    }
  },
  "links": {
    "self": {
      "href": "string"
    },
    "assignments": {
      "href": "string"
    }
  }
}

Deletes a space.

Path Parameters DELETE /spaces/{spaceId}

spaceId
string<uid>

The ID of the space to delete.

Responses DELETE /spaces/{spaceId}

204
object

Space deleted.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Space delete operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

DELETE/spaces/{spaceId}

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

Creates an assignment.

Path Parameters POST /spaces/{spaceId}/assignments

spaceId
string<uid>

The ID of the space of the assignment.

Request Body POST /spaces/{spaceId}/assignments

application/json

No description

Responses POST /spaces/{spaceId}/assignments

201
application/json

Assignment created.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Assignment create operation denied.

404
application/json

Space not found or access denied.

409
application/json

Assignment already exists. assigneeId must be unique.

500
application/json

Internal server error.

POST/spaces/{spaceId}/assignments

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

Request POST /spaces/{spaceId}/assignments

{
  "type": "user",
  "assigneeId": "string",
  "roles": []
}

Response POST /spaces/{spaceId}/assignments

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.078Z",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Retrieves the assignments of the space matching the query.

Path Parameters GET /spaces/{spaceId}/assignments

spaceId
string<uid>

The ID of the space of the assignment.

Query Parameters GET /spaces/{spaceId}/assignments

limit
optional, default=10
integer<int32>

Maximum number of assignments to return.

next
optional
string

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

prev
optional
string

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

Responses GET /spaces/{spaceId}/assignments

200
application/json

Assignments retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Assignments retrieve operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

GET/spaces/{spaceId}/assignments

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

Response GET /spaces/{spaceId}/assignments

{
  "data": [
    {
      "id": "string",
      "type": "user",
      "assigneeId": "string",
      "roles": [],
      "spaceId": "string",
      "tenantId": "string",
      "createdAt": "2022-05-18T10:58:17.078Z",
      "createdBy": "string",
      "updatedAt": "2022-05-18T10:58:17.078Z",
      "links": {
        "self": {
          "href": "string"
        },
        "space": {
          "href": "string"
        }
      }
    }
  ],
  "meta": {
    "count": 0
  },
  "links": {
    "self": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "next": {
      "href": "string"
    }
  }
}

Retrieves a single assignment by ID.

Path Parameters GET /spaces/{spaceId}/assignments/{assignmentId}

spaceId
string<uid>

The ID of the space of the assignment.

assignmentId
string<uid>

The ID of the assignment to retrieve.

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

200
application/json

Assignment retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Assignment retrieve operation denied.

404
application/json

Space not found or access denied or assignment not found.

500
application/json

Internal server error.

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

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

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

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.078Z",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Updates a single assignment by ID. The complete list of roles must be provided.

experimental

Path Parameters PUT /spaces/{spaceId}/assignments/{assignmentId}

spaceId
string<uid>

The ID of the space of the assignment.

assignmentId
string<uid>

The ID of the assignment to update.

Request Body PUT /spaces/{spaceId}/assignments/{assignmentId}

application/json

No description

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

200
application/json

Assignment updated.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Assignment update operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

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

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

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

{
  "roles": []
}

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

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "updatedAt": "2022-05-18T10:58:17.078Z",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Deletes an assignment.

Path Parameters DELETE /spaces/{spaceId}/assignments/{assignmentId}

spaceId
string<uid>

The ID of the space of the assignment.

assignmentId
string<uid>

The ID of the assignment to delete.

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

204
object

Assignment deleted.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Assignment delete operation denied.

404
application/json

Space not found or access denied or assignment not found.

500
application/json

Internal server error.

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

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

Creates a share.

experimental

Path Parameters POST /spaces/{spaceId}/shares

spaceId
string<uid>

The ID of the space of the share.

Request Body POST /spaces/{spaceId}/shares

application/json

No description

Responses POST /spaces/{spaceId}/shares

201
application/json

Share created.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Share create operation denied.

404
application/json

Space not found or access denied.

409
application/json

Share already exists. assigneeId must be unique.

500
application/json

Internal server error.

POST/spaces/{spaceId}/shares

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

Request POST /spaces/{spaceId}/shares

{
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "resourceType": "string",
  "resourceId": "string",
  "resourceName": "string"
}

Response POST /spaces/{spaceId}/shares

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "resourceName": "string",
  "resourceType": "app",
  "resourceId": "string",
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Retrieves the shares of the space matching the query.

experimental

Path Parameters GET /spaces/{spaceId}/shares

spaceId
string<uid>

The ID of the space of the shares.

Query Parameters GET /spaces/{spaceId}/shares

name
string

The name of the shared resource.

resourceId
string

The id of the shared resource.

resourceType
string

The type of the shared resource.

groupId
string

The groupId of the shared resource.

userId
string

The groupId of the shared resource.

limit
optional, default=10
integer<int32>

Maximum number of shares to return.

next
optional
string

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

prev
optional
string

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

Responses GET /spaces/{spaceId}/shares

200
application/json

Shares retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Shares retrieve operation denied.

404
application/json

Space not found or access denied.

500
application/json

Internal server error.

GET/spaces/{spaceId}/shares

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

Response GET /spaces/{spaceId}/shares

{
  "data": [
    {
      "id": "string",
      "type": "user",
      "assigneeId": "string",
      "roles": [],
      "resourceName": "string",
      "resourceType": "app",
      "resourceId": "string",
      "spaceId": "string",
      "tenantId": "string",
      "createdAt": "2022-05-18T10:58:17.078Z",
      "createdBy": "string",
      "links": {
        "self": {
          "href": "string"
        },
        "space": {
          "href": "string"
        }
      }
    }
  ],
  "meta": {
    "count": 0
  },
  "links": {
    "self": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "next": {
      "href": "string"
    }
  }
}

Retrieves a single share by ID.

experimental

Path Parameters GET /spaces/{spaceId}/shares/{shareId}

spaceId
string<uid>

The ID of the space of the share.

shareId
string<uid>

The ID of the share to retrieve.

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

200
application/json

Share retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Share retrieve operation denied.

404
application/json

Space not found or access denied or share not found.

500
application/json

Internal server error.

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

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

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

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "resourceName": "string",
  "resourceType": "app",
  "resourceId": "string",
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Patches (updates) a share (partially).

experimental

Path Parameters PATCH /spaces/{spaceId}/shares/{shareId}

spaceId
string<uid>

The ID of the space to which the share belongs.

shareId
string<uid>

The ID of the share to update.

Request Body PATCH /spaces/{spaceId}/shares/{shareId}

application/json

No description

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

200
application/json

Share patched (updated).

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

Share patch (update) operation denied.

404
application/json

Share not found or access denied.

500
application/json

Internal server error.

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

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

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

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

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

{
  "id": "string",
  "type": "user",
  "assigneeId": "string",
  "roles": [],
  "resourceName": "string",
  "resourceType": "app",
  "resourceId": "string",
  "spaceId": "string",
  "tenantId": "string",
  "createdAt": "2022-05-18T10:58:17.078Z",
  "createdBy": "string",
  "links": {
    "self": {
      "href": "string"
    },
    "space": {
      "href": "string"
    }
  }
}

Deletes a Share.

experimental

Path Parameters DELETE /spaces/{spaceId}/shares/{shareId}

spaceId
string<uid>

The ID of the space of the share.

shareId
string<uid>

The ID of the share to delete.

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

204
object

Share deleted.

401
application/json

Unauthorized, JWT invalid or not provided.

403
application/json

share delete operation denied.

404
application/json

Space not found or access denied or share not found.

500
application/json

Internal server error.

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

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

Gets a list of distinct space types.

Responses GET /spaces/types

200
application/json

Space types retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

500
application/json

Internal server error.

GET/spaces/types

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

Response GET /spaces/types

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

Retrieves spaces that the current user has access to with provided space IDs or names.

Request Body POST /spaces/filter

application/json

No description

Responses POST /spaces/filter

200
application/json

Spaces retrieved.

401
application/json

Unauthorized, JWT invalid or not provided.

500
application/json

Internal server error.

POST/spaces/filter

curl "https://your-tenant.us.qlikcloud.com/api/v1/spaces/filter" \
 -X POST \
 -H "Authorization: Bearer <API-key>" \
 -H "Content-type: application/json" \
 -d '{"ids":[],"names":[]}'

Request POST /spaces/filter

{
  "ids": [],
  "names": []
}

Response POST /spaces/filter

{
  "data": [
    {
      "id": "string",
      "type": "shared",
      "ownerId": "string",
      "tenantId": "string",
      "name": "string",
      "description": "string",
      "createdAt": "2022-05-18T10:58:17.078Z",
      "createdBy": "string",
      "updatedAt": "2022-05-18T10:58:17.078Z",
      "meta": {
        "actions": [],
        "roles": [],
        "assignableRoles": {
          "description": "The supported roles for Shared spaces.",
          "type": "string",
          "enum": [
            "facilitator",
            "consumer",
            "producer",
            "dataconsumer"
          ],
          "dereferenced": "#/definitions/SharedSpaceRoleType"
        }
      },
      "links": {
        "self": {
          "href": "string"
        },
        "assignments": {
          "href": "string"
        }
      }
    }
  ],
  "meta": {
    "count": 0
  },
  "links": {
    "self": {
      "href": "string"
    },
    "prev": {
      "href": "string"
    },
    "next": {
      "href": "string"
    }
  }
}

Spaces

object

Properties

data

No description

meta
object

No description

links

No description

Space

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.

Properties

id
string<uid>

No description

type
optional
string

No description

Enum:

shared

managed

data

ownerId
optional
string<uid>

The user ID of the space owner.

tenantId
string<uid>

No description

name
string

The name of the space. Personal spaces do not have a name.

description
optional
string

The description of the space. Personal spaces do not have a description.

createdAt
optional
string<date-time>

No description

createdBy
optional
string<uid>

The ID of the user who created the space.

updatedAt
optional
string<date-time>

No description

meta

No description

links

No description

SpaceCreate

Properties

name
pattern='^[^\"\*\?\<\>\/\|\\\:]+$'
string

The name of the space. Personal spaces do not have a name.

description
optional
string

The description of the space. Personal spaces do not have a description.

type
string

No description

Enum:

shared

managed

data

SpaceUpdate

Properties

name
pattern='^[^\"\*\?\<\>\/\|\\\:]+$'
string

No description

description
string

The description of the space. Personal spaces do not have a description.

ownerId
string<uid>

The user id of the space owner.

SpacePatch

Array<object>

Properties

op
string

The operation to be performed

Enum:

replace

path
string

Field of Space to be patched (updated)

Enum:

/name

/ownerId

/description

value
string

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.

RawSpaces

Properties

data

No description

RawSpace

object

Properties

id
string<uid>

The unique ID of the space.

ownerId
string<uid>

The user ID of the space owner.

type
string

The type of the space.

Enum:

shared

managed

data

disabled
default=false
boolean

No description

roles
Array<RoleType>

The list of roles assigned to the current user.

RawShare

object

Properties

resourceId
string<uid>

The resource ID of the share.

resourceType

The type of the resource being shared.

role
Array<string>

The list of roles assigned to the current user.

RawSpacesCompressed

Properties

data

No description

RawSpaceCompressed

object

Properties

id
Array<string<uid>>

No description

ownerId
string<uid>

The user ID of the space owner.

type
string

The type of the space.

Enum:

shared

managed

data

roles
Array<RoleType>

The list of roles assigned to the current user.

FilterSpaces

Properties

ids
Array<string<uid>>

No description

names
Array<string>

No description

Assignments

object

Properties

data

No description

meta
object

No description

links

No description

Assignment

Properties

id
string<uid>

No description

type
string

No description

Enum:

user

group

assigneeId
string<uid>

The userId or groupId based on the type.

roles
Array<RoleType>

The roles assigned to a user or group. Must not be empty.

spaceId
string<uid>

No description

tenantId
string<uid>

No description

createdAt
optional
string<date-time>

No description

createdBy
optional
string<uid>

The ID of the user who created the assignment.

updatedAt
optional
string<date-time>

No description

links

No description

AssignmentCreate

Properties

type
string

No description

Enum:

user

group

assigneeId
string<uid>

The userId or groupId based on the type.

roles
Array<RoleType>

The roles assigned to the assigneeId

AssignmentUpdate

Properties

roles
Array<RoleType>

No description

RoleType

string

Supported roles by space type:

  • Shared: consumer, dataconsumer, facilitator, producer
  • Managed: consumer, contributor, dataconsumer, facilitator, publisher
  • Data: consumer, dataconsumer, facilitator, operator, producer, publisher

SharedSpaceRoleType

string

The supported roles for Shared spaces.

ActionName

string

The supported actions for user-created spaces like Shared or Managed spaces.

Properties

href
string

URL that defines the resource.

SpaceTypes

The distinct types of spaces (shared, managed, etc)

Properties

data
Array<SpaceType>

No description

SpaceType

string

The name of the type.

SpacesUsage

object

Number of spaces by type.

Properties

shared
integer<int32>

No description

managed
integer<int32>

No description

SpacesSettings

object

Space specific settings.

Properties

allowOffline
boolean

No description

allowShares
boolean

No description

SpacesSettingsUpdate

object

Properties

allowOffline
boolean

No description

allowShares
boolean

No description

Shares

object

Properties

data

No description

meta
object

No description

links

No description

Share

Properties

id
string<uid>

No description

type
string

No description

Enum:

user

group

assigneeId
string<uid>

The userId or groupId based on the type.

roles
optional
Array<ShareRoleType>

The roles assigned to the assigneeId

resourceName
string

The name of the shared resource.

resourceType

The type of the shared resource.

Enum:

app

resourceId
string<uid>

The Id of the shared resource.

spaceId
string<uid>

No description

tenantId
string<uid>

No description

createdAt
optional
string<date-time>

No description

createdBy
optional
string<uid>

The ID of the user who created the share.

links

No description

ShareCreate

Properties

type
string

No description

Enum:

user

group

assigneeId
string<uid>

The userId or groupId based on the type.

roles

The roles assigned to the assigneeId

resourceType
string<uid>

The resource type for the shared item.

resourceId
string<uid>

The resource id for the shared item.

resourceName
string<uid>

The resource name for the shared item.

ShareRoleType

Supported roles by space type:

  • Shared: consumer
  • Managed: consumer, contributor

SharePatch

Array<object>

Properties

op
string

The operation to be performed

Enum:

replace

path
string

Field of Share to be patched (updated)

Enum:

/roles

value
string

The value to be used within the operations.

  • roles: The roles assigned to the assigneeId.

Errors

Properties

code
deprecated
string

The error code.

title
deprecated
string

Summary of the problem.

detail
deprecated
string

A human-readable explanation specific to the occurrence of this problem.

meta
deprecated
object

Additional properties relating to the error.

source
deprecated

References to the source of the error.

errors

No description

traceId
string

No description

Error

An error object.

Properties

code
string

The error code.

title
string

Summary of the problem.

detail
optional
string

A human-readable explanation specific to the occurrence of this problem.

meta
optional

Additional properties relating to the error.

Health

object

Properties

message
string

It should return OK.

Ready

object

Properties

message
string

It should return OK.

v1.6.0
Was this page helpful?