Cross Tenant Collections

Returns a list of cross tenant collections

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Responses

200

OK

CollectionIdstring · nullableOptional

A unique identifier of the collection

CollectionNamestring · min: 1Required

A string with name of the collection

Tenantsstring · nullableOptional

Comma delimited list of tenant codes

Groupsstring · nullableOptional

Comma delimited list of group ids

Devicesstring · nullableOptional

Comma delimited list of device ids

IncludeSubtenantsbooleanOptional

Whether all subtenants are included

get/V2/{tenantVarCode}/crosstenantcollections

GET /V2/{tenantVarCode}/crosstenantcollections HTTP/1.1
Accept: */*

200

OK

[
  {
    "CollectionId": "text",
    "CollectionName": "text",
    "Tenants": "text",
    "Groups": "text",
    "Devices": "text",
    "IncludeSubtenants": true
  }
]

Creates a new cross tenant collection

post

Path parameters

tenantVarCodestringRequired

Tenant Var Code

Body

CollectionIdstring · nullableOptional

A unique identifier of the collection

CollectionNamestring · min: 1Required

A string with name of the collection

Tenantsstring · nullableOptional

Comma delimited list of tenant codes

Groupsstring · nullableOptional

Comma delimited list of group ids

Devicesstring · nullableOptional

Comma delimited list of device ids

IncludeSubtenantsbooleanOptional

Whether all subtenants are included

Responses

200

OK

No content

post/V2/{tenantVarCode}/crosstenantcollections

POST /V2/{tenantVarCode}/crosstenantcollections HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "CollectionId": "text",
  "CollectionName": "text",
  "Tenants": "text",
  "Groups": "text",
  "Devices": "text",
  "IncludeSubtenants": true
}

200

OK

No content

Returns cross tenant collection

get

Path parameters

tenantVarCodestringRequired

Tenant Var Code

collectionIdstringRequired

Cross Tenant Collection Collection Id

Responses

200

OK

CollectionIdstring · nullableOptional

A unique identifier of the collection

CollectionNamestring · min: 1Required

A string with name of the collection

Tenantsstring · nullableOptional

Comma delimited list of tenant codes

Groupsstring · nullableOptional

Comma delimited list of group ids

Devicesstring · nullableOptional

Comma delimited list of device ids

IncludeSubtenantsbooleanOptional

Whether all subtenants are included

get/V2/{tenantVarCode}/crosstenantcollections/{collectionId}

GET /V2/{tenantVarCode}/crosstenantcollections/{collectionId} HTTP/1.1
Accept: */*

200

OK

{
  "CollectionId": "text",
  "CollectionName": "text",
  "Tenants": "text",
  "Groups": "text",
  "Devices": "text",
  "IncludeSubtenants": true
}

Updates cross tenant collection

put

Path parameters

tenantVarCodestringRequired

Tenant Var Code

collectionIdstringRequired

Cross Tenant Collection Id

Body

CollectionIdstring · nullableOptional

A unique identifier of the collection

CollectionNamestring · min: 1Required

A string with name of the collection

Tenantsstring · nullableOptional

Comma delimited list of tenant codes

Groupsstring · nullableOptional

Comma delimited list of group ids

Devicesstring · nullableOptional

Comma delimited list of device ids

IncludeSubtenantsbooleanOptional

Whether all subtenants are included

Responses

200

OK

No content

put/V2/{tenantVarCode}/crosstenantcollections/{collectionId}

PUT /V2/{tenantVarCode}/crosstenantcollections/{collectionId} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 122

{
  "CollectionId": "text",
  "CollectionName": "text",
  "Tenants": "text",
  "Groups": "text",
  "Devices": "text",
  "IncludeSubtenants": true
}

200

OK

No content

Deletes cross tenant collection

delete

Path parameters

tenantVarCodestringRequired

Tenant Var Code

collectionIdstringRequired

Cross Tenant Collection Id

Responses

200

OK

No content

delete/V2/{tenantVarCode}/crosstenantcollections/{collectionId}

DELETE /V2/{tenantVarCode}/crosstenantcollections/{collectionId} HTTP/1.1
Accept: */*

200

OK

No content