CMX Service APIs Data Structures
AuthCredentialsServiceState
JSON Example
{
"bearer": "boolean",
"documentSelfLink": "string",
"password": "boolean",
"privateKey": "string",
"privateKeyId": "string",
"publicKey": "string",
"tenantLinks": [
"string"
],
"type": "string",
"userEmail": "string"
}boolean
bearer
Optional
bearer
object
customProperties
Optional
customProperties
string
documentSelfLink
Optional
documentSelfLink
boolean
password
Optional
password
string
privateKey
Optional
privateKey
string
privateKeyId
Optional
privateKeyId
string
publicKey
Optional
publicKey
array of string
tenantLinks
Optional
tenantLinks
string
type
Optional
type
string
userEmail
Optional
userEmail
AuthCredentialsServiceState_1
JSON Example
{
"documentSelfLink": "string",
"privateKey": "string",
"privateKeyId": "string",
"publicKey": "string",
"tenantLinks": [
"string"
],
"type": "string",
"userEmail": "string"
}object
customProperties
Optional
customProperties
string
documentSelfLink
Optional
documentSelfLink
string
privateKey
Optional
privateKey
string
privateKeyId
Optional
privateKeyId
string
publicKey
Optional
publicKey
array of string
tenantLinks
Optional
tenantLinks
string
type
Optional
type
string
userEmail
Optional
userEmail
AuthorizationContext
JSON Example
{
"claims": {
"audience": [
"string"
],
"expirationTime": "integer",
"issuedAt": "integer",
"issuer": "string",
"jwtId": "string",
"notBefore": "integer",
"subject": "string"
},
"guestUser": "boolean",
"systemUser": "boolean",
"token": "string"
}boolean
guestUser
Optional
guestUser
boolean
systemUser
Optional
systemUser
string
token
Optional
token
AuthorizationContext_1
JSON Example
{
"claims": {
"audience": [
"string"
],
"expirationTime": "integer",
"issuedAt": "integer",
"issuer": "string",
"jwtId": "string",
"notBefore": "integer",
"subject": "string"
},
"token": "string"
}string
token
Optional
token
Claims
JSON Example
{
"audience": [
"string"
],
"expirationTime": "integer",
"issuedAt": "integer",
"issuer": "string",
"jwtId": "string",
"notBefore": "integer",
"subject": "string"
}array of string
audience
Optional
audience
integer As int64 As int64
expirationTime
Optional
expirationTime
integer As int64 As int64
issuedAt
Optional
issuedAt
string
issuer
Optional
issuer
string
jwtId
Optional
jwtId
integer As int64 As int64
notBefore
Optional
notBefore
object
properties
Optional
properties
string
subject
Optional
subject
CompletionHandler
This data structure has no properties.
Consumer_Operation__1
This data structure has no properties.
Consumer_Operation__2
This data structure has no properties.
Consumer_Operation__3
This data structure has no properties.
Consumer_ServerSentEvent_
This data structure has no properties.
Consumer_Throwable_
This data structure has no properties.
K8SCluster
JSON Example
{
"address": "string",
"authCredentialsLink": "string",
"caCertificate": "string",
"clusterType": "string",
"createdMillis": "integer",
"credentials": {
"bearer": "boolean",
"documentSelfLink": "string",
"password": "boolean",
"privateKey": "string",
"privateKeyId": "string",
"publicKey": "string",
"tenantLinks": [
"string"
],
"type": "string",
"userEmail": "string"
},
"description": "string",
"directConnection": "boolean",
"endpointId": "string",
"externalLink": "string",
"global": "boolean",
"id": "string",
"kubernetesWorkerInstances": "integer",
"lastOperation": "string",
"lastOperationMessage": "string",
"lastOperationStatus": "string",
"lastRefreshedMillis": "integer",
"name": "string",
"nodes": [
{
"allocatablePods": "integer",
"cpuCores": "number",
"cpuUsage": "number",
"createdMillis": "integer",
"description": "string",
"id": "string",
"memoryUsage": "number",
"name": "string",
"orgId": "string",
"totalMemory": "number",
"updatedMillis": "integer"
}
],
"orgId": "string",
"owner": "string",
"projectId": "string",
"remainingUnreachableRetryThreshold": "integer",
"shared": "boolean",
"status": "string",
"updatedMillis": "integer",
"version": "string"
}string
address
Optional
address
string
authCredentialsLink
Optional
authCredentialsLink
string
caCertificate
Optional
caCertificate
string
clusterType
Optional
clusterType
integer As int64 As int64
createdMillis
Optional
createdMillis
object
customProperties
Optional
customProperties
string
description
Optional
description
boolean
directConnection
Optional
directConnection
string
endpointId
Optional
endpointId
string
externalLink
Optional
externalLink
boolean
global
Optional
global
string As uuid As uuid
id
Optional
id
integer As int32 As int32
kubernetesWorkerInstances
Optional
kubernetesWorkerInstances
string
lastOperation
Optional
lastOperation
string
lastOperationMessage
Optional
lastOperationMessage
string
lastOperationStatus
Optional
lastOperationStatus
integer As int64 As int64
lastRefreshedMillis
Optional
lastRefreshedMillis
string
name
Optional
name
string
orgId
Optional
orgId
string
owner
Optional
owner
string
projectId
Optional
projectId
integer As int32 As int32
remainingUnreachableRetryThreshold
Optional
remainingUnreachableRetryThreshold
boolean
shared
Optional
shared
string
status
Optional
status
integer As int64 As int64
updatedMillis
Optional
updatedMillis
string
version
Optional
version
K8SCluster_1
JSON Example
{
"address": "string",
"authCredentialsLink": "string",
"caCertificate": "string",
"clusterType": "string",
"createdMillis": "integer",
"credentials": {
"documentSelfLink": "string",
"privateKey": "string",
"privateKeyId": "string",
"publicKey": "string",
"tenantLinks": [
"string"
],
"type": "string",
"userEmail": "string"
},
"description": "string",
"endpointId": "string",
"global": "boolean",
"id": "string",
"kubernetesWorkerInstances": "integer",
"lastOperation": "string",
"lastOperationMessage": "string",
"lastOperationStatus": "string",
"lastRefreshedMillis": "integer",
"name": "string",
"nodes": [
{
"allocatablePods": "integer",
"cpuCores": "number",
"cpuUsage": "number",
"createdMillis": "integer",
"description": "string",
"id": "string",
"memoryUsage": "number",
"name": "string",
"orgId": "string",
"totalMemory": "number",
"updatedMillis": "integer"
}
],
"orgId": "string",
"owner": "string",
"projectId": "string",
"remainingUnreachableRetryThreshold": "integer",
"shared": "boolean",
"status": "string",
"updatedMillis": "integer",
"version": "string"
}string
address
Optional
address
string
authCredentialsLink
Optional
authCredentialsLink
string
caCertificate
Optional
caCertificate
string
clusterType
Optional
clusterType
integer As int64 As int64
createdMillis
Optional
createdMillis
object
customProperties
Optional
customProperties
string
description
Optional
description
string
endpointId
Optional
endpointId
boolean
global
Optional
global
string As uuid As uuid
id
Optional
id
integer As int32 As int32
kubernetesWorkerInstances
Optional
kubernetesWorkerInstances
string
lastOperation
Optional
lastOperation
string
lastOperationMessage
Optional
lastOperationMessage
string
lastOperationStatus
Optional
lastOperationStatus
integer As int64 As int64
lastRefreshedMillis
Optional
lastRefreshedMillis
string
name
Optional
name
string
orgId
Optional
orgId
string
owner
Optional
owner
string
projectId
Optional
projectId
integer As int32 As int32
remainingUnreachableRetryThreshold
Optional
remainingUnreachableRetryThreshold
boolean
shared
Optional
shared
string
status
Optional
status
integer As int64 As int64
updatedMillis
Optional
updatedMillis
string
version
Optional
version
K8SNamespace
JSON Example
{
"authCredentialsLink": "string",
"clusterId": "string",
"createdMillis": "integer",
"description": "string",
"externalLink": "string",
"id": "string",
"name": "string",
"orgId": "string",
"owner": "string",
"persisted": "boolean",
"projectId": "string",
"registered": "boolean",
"shared": "boolean",
"status": "string",
"updatedMillis": "integer"
}string
authCredentialsLink
Optional
authCredentialsLink
string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string
description
Optional
description
string
externalLink
Optional
externalLink
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
orgId
Optional
orgId
string
owner
Optional
owner
boolean
persisted
Optional
persisted
string
projectId
Optional
projectId
boolean
registered
Optional
registered
boolean
shared
Optional
shared
string
status
Optional
status
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SNamespace_1
JSON Example
{
"authCredentialsLink": "string",
"clusterId": "string",
"createdMillis": "integer",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"owner": "string",
"projectId": "string",
"registered": "boolean",
"shared": "boolean",
"status": "string",
"updatedMillis": "integer"
}string
authCredentialsLink
Optional
authCredentialsLink
string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
orgId
Optional
orgId
string
owner
Optional
owner
string
projectId
Optional
projectId
boolean
registered
Optional
registered
boolean
shared
Optional
shared
string
status
Optional
status
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SNode
JSON Example
{
"allocatablePods": "integer",
"cpuCores": "number",
"cpuUsage": "number",
"createdMillis": "integer",
"description": "string",
"id": "string",
"memoryUsage": "number",
"name": "string",
"orgId": "string",
"totalMemory": "number",
"updatedMillis": "integer"
}integer As int32 As int32
allocatablePods
Optional
allocatablePods
number As double As double
cpuCores
Optional
cpuCores
number As double As double
cpuUsage
Optional
cpuUsage
integer As int64 As int64
createdMillis
Optional
createdMillis
string
description
Optional
description
string As uuid As uuid
id
Optional
id
number As double As double
memoryUsage
Optional
memoryUsage
string
name
Optional
name
string
orgId
Optional
orgId
number As double As double
totalMemory
Optional
totalMemory
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SResourceQuota
JSON Example
{
"active": "boolean",
"clusterId": "string",
"createdMillis": "integer",
"definition": "string",
"description": "string",
"id": "string",
"managed": "boolean",
"name": "string",
"namespaceId": "string",
"namespaceName": "string",
"orgId": "string",
"resource": "string",
"updatedMillis": "integer",
"usage": "string"
}boolean
active
Optional
active
string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string
definition
Optional
definition
string
description
Optional
description
string As uuid As uuid
id
Optional
id
boolean
managed
Optional
managed
string
name
Optional
name
string As uuid As uuid
namespaceId
Optional
namespaceId
string
namespaceName
Optional
namespaceName
string
orgId
Optional
orgId
string
resource
Optional
resource
integer As int64 As int64
updatedMillis
Optional
updatedMillis
string
usage
Optional
usage
K8SZoneClusterAssignment
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_1
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_2
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_3
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_4
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_5
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneClusterAssignment_6
JSON Example
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}string As uuid As uuid
clusterId
Optional
clusterId
integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
string
pksClusterUuid
Optional
pksClusterUuid
boolean
preferMasterIp
Optional
preferMasterIp
integer As int32 As int32
priority
Optional
priority
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_1
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_2
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_3
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_4
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_5
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZoneResourceAssignment_6
JSON Example
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
boolean
enabled
Optional
enabled
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
resourceId
Optional
resourceId
string
resourceType
Optional
resourceType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZone_1
JSON Example
{
"clusters": [
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"createdMillis": "integer",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projects": [
{
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"priority": "integer",
"projectId": "string",
"updatedMillis": "integer"
}
],
"providerId": "string",
"providerType": "string",
"resources": [
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
object
customProperties
Optional
customProperties
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
orgId
Optional
orgId
string
providerId
Optional
providerId
string
providerType
Optional
providerType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZone_3
JSON Example
{
"clusters": [
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"createdMillis": "integer",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projects": [
{
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"priority": "integer",
"projectId": "string",
"updatedMillis": "integer"
}
],
"providerId": "string",
"providerType": "string",
"resources": [
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
object
customProperties
Optional
customProperties
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
orgId
Optional
orgId
string
providerId
Optional
providerId
string
providerType
Optional
providerType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
K8SZone_5
JSON Example
{
"clusters": [
{
"clusterId": "string",
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"pksClusterUuid": "string",
"preferMasterIp": "boolean",
"priority": "integer",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"createdMillis": "integer",
"description": "string",
"id": "string",
"name": "string",
"orgId": "string",
"projects": [
{
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"priority": "integer",
"projectId": "string",
"updatedMillis": "integer"
}
],
"providerId": "string",
"providerType": "string",
"resources": [
{
"createdMillis": "integer",
"enabled": "boolean",
"id": "string",
"orgId": "string",
"priority": "integer",
"resourceId": "string",
"resourceType": "string",
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}
],
"tagLinks": [
"string"
],
"tags": [
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}
],
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
object
customProperties
Optional
customProperties
string
description
Optional
description
string As uuid As uuid
id
Optional
id
string
name
Optional
name
string
orgId
Optional
orgId
string
providerId
Optional
providerId
string
providerType
Optional
providerType
array of string
tagLinks
Optional
tagLinks
integer As int64 As int64
updatedMillis
Optional
updatedMillis
Mono_K8SCluster_
This data structure has no properties.
Mono_K8SNamespace_
This data structure has no properties.
Mono_K8SResourceQuota_
This data structure has no properties.
Mono_K8SZone_
This data structure has no properties.
Mono_K8SZone__1
This data structure has no properties.
Mono_K8SZone__2
This data structure has no properties.
Mono_K8SZone__3
This data structure has no properties.
Mono_K8sClusterState_
This data structure has no properties.
Mono_List_PKSCluster_
This data structure has no properties.
Mono_List_PKSPlan_
This data structure has no properties.
Mono_Map_string_string_
This data structure has no properties.
Mono_NodeList_
This data structure has no properties.
Mono_Page_K8SCluster_
This data structure has no properties.
Mono_Page_K8SNamespace_
This data structure has no properties.
Mono_Page_K8SResourceQuota_
This data structure has no properties.
Mono_Page_K8SZone_
This data structure has no properties.
Mono_Page_SupervisorCluster_
This data structure has no properties.
Mono_Page_SupervisorCluster__1
This data structure has no properties.
Mono_Page_SupervisorNamespace_
This data structure has no properties.
Mono_ResourceResponse_
This data structure has no properties.
Mono_ResponseEntity_string_
This data structure has no properties.
Mono_SupervisorCluster_
This data structure has no properties.
Mono_SupervisorNamespaceSyncResponseDTO_
This data structure has no properties.
Mono_SupervisorNamespace_
This data structure has no properties.
Mono_Void_
This data structure has no properties.
Node
JSON Example
{
"apiVersion": "string",
"kind": "string",
"metadata": {
"clusterName": "string",
"creationTimestamp": "string",
"generateName": "string",
"name": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string"
},
"spec": {
"externalId": "string",
"podCIDR": "string",
"providerId": "string",
"unschedulable": "boolean"
},
"status": {
"phase": "string"
}
}string
apiVersion
Optional
apiVersion
string
kind
Optional
kind
NodeSpec
JSON Example
{
"externalId": "string",
"podCIDR": "string",
"providerId": "string",
"unschedulable": "boolean"
}string
externalId
Optional
externalId
string
podCIDR
Optional
podCIDR
string
providerId
Optional
providerId
boolean
unschedulable
Optional
unschedulable
NodeStatus
JSON Example
{
"phase": "string"
}object
allocatable
Optional
allocatable
object
capacity
Optional
capacity
string
phase
Optional
phase
ObjectMeta
JSON Example
{
"clusterName": "string",
"creationTimestamp": "string",
"generateName": "string",
"name": "string",
"namespace": "string",
"selfLink": "string",
"uid": "string"
}object
annotations
Optional
annotations
string
clusterName
Optional
clusterName
string
creationTimestamp
Optional
creationTimestamp
string
generateName
Optional
generateName
object
labels
Optional
labels
string
name
Optional
name
string
namespace
Optional
namespace
string
selfLink
Optional
selfLink
string
uid
Optional
uid
PKSCluster
JSON Example
{
"hostnameAddress": "string",
"ipAddress": "string",
"kubernetes_master_ips": [
"string"
],
"last_action": "string",
"last_action_description": "string",
"last_action_state": "string",
"name": "string",
"plan_name": "string",
"uuid": "string"
}string
hostnameAddress
Optional
hostnameAddress
string
ipAddress
Optional
ipAddress
array of string
kubernetes_master_ips
Optional
kubernetes_master_ips
string
last_action
Optional
last_action
string
last_action_description
Optional
last_action_description
string
last_action_state
Optional
last_action_state
string
name
Optional
name
object
parameters
Optional
parameters
string
plan_name
Optional
plan_name
string
uuid
Optional
uuid
Pageable
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
Pageable_1
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
Pageable_2
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
Pageable_3
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
Pageable_4
JSON Example
{
"offset": "integer",
"pageNumber": "integer",
"pageSize": "integer",
"paged": "boolean",
"sort": {
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
},
"unpaged": "boolean"
}integer As int64 As int64
offset
Optional
offset
integer As int32 As int32
pageNumber
Optional
pageNumber
integer As int32 As int32
pageSize
Optional
pageSize
boolean
paged
Optional
paged
boolean
unpaged
Optional
unpaged
Parameter
JSON Example
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}string
description
Optional
description
string
name
Optional
name
string
paramDef
Optional
paramDef
boolean
required
Optional
required
string
type
Optional
type
string
value
Optional
value
Predicate_Operation__1
This data structure has no properties.
Predicate_Operation__2
This data structure has no properties.
Predicate_Operation__3
This data structure has no properties.
Predicate_Operation__4
This data structure has no properties.
Predicate_Operation__5
This data structure has no properties.
Principal
JSON Example
{
"name": "string"
}string
name
Optional
name
ProjectPriorityAssignment
JSON Example
{
"createdMillis": "integer",
"id": "string",
"orgId": "string",
"priority": "integer",
"projectId": "string",
"updatedMillis": "integer"
}integer As int64 As int64
createdMillis
Optional
createdMillis
string As uuid As uuid
id
Optional
id
string
orgId
Optional
orgId
integer As int32 As int32
priority
Optional
priority
string
projectId
Optional
projectId
integer As int64 As int64
updatedMillis
Optional
updatedMillis
PropertyDescription
JSON Example
{
"elementDescription": "PropertyDescription Object",
"enumValues": [
"string"
],
"indexingOptions": [
"string"
],
"kind": "string",
"propertyDocumentation": "string",
"typeName": "string",
"usageOptions": [
"string"
]
}array of string
enumValues
Optional
enumValues
object
exampleValue
Optional
exampleValue
object
fieldDescriptions
Optional
fieldDescriptions
array of string
indexingOptions
Optional
indexingOptions
string
kind
Optional
kind
string
propertyDocumentation
Optional
propertyDocumentation
string
typeName
Optional
typeName
array of string
usageOptions
Optional
usageOptions
PublicKey
JSON Example
{
"algorithm": "string",
"encoded": "string",
"format": "string"
}string
algorithm
Optional
algorithm
string As byte As byte
encoded
Optional
encoded
string
format
Optional
format
ResourceRequest
JSON Example
{
"actionName": "string",
"callbackUrl": "string",
"deploymentId": "string",
"deploymentName": "string",
"operation": "string",
"operationTimeoutSeconds": "integer",
"projectId": "string",
"requestId": "string",
"resourceLink": "string",
"resourceName": "string",
"resourceRequestId": "string",
"resourceType": "string",
"tenantLinks": [
"string"
]
}object
actionInputProperties
Optional
actionInputProperties
string
actionName
Optional
actionName
object
allocationResource
Optional
allocationResource
string
callbackUrl
Optional
callbackUrl
string
deploymentId
Optional
deploymentId
string
deploymentName
Optional
deploymentName
string
operation
Optional
operation
integer As int64 As int64
operationTimeoutSeconds
Optional
operationTimeoutSeconds
string
projectId
Optional
projectId
string
requestId
Optional
requestId
string
resourceLink
Optional
resourceLink
object
resourceModifiedProperties
Optional
resourceModifiedProperties
string
resourceName
Optional
resourceName
object
resourceProperties
Optional
resourceProperties
string
resourceRequestId
Optional
resourceRequestId
string
resourceType
Optional
resourceType
array of string
tenantLinks
Optional
tenantLinks
ResumeRequest
JSON Example
{
"actionName": "string",
"id": "string",
"operation": "string",
"requestId": "string",
"resourceType": "string"
}string
actionName
Optional
actionName
string As uuid As uuid
id
Optional
id
string
operation
Optional
operation
string
requestId
Optional
requestId
string
resourceType
Optional
resourceType
Route
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_1
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_2
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_3
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_4
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_5
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
Route_6
JSON Example
{
"action": "string",
"description": "string",
"parameters": [
{
"description": "string",
"name": "string",
"paramDef": "string",
"required": "boolean",
"type": "string",
"value": "string"
}
],
"path": "string",
"supportLevel": "string"
}string
action
Optional
action
string
description
Optional
description
string
path
Optional
path
string
supportLevel
Optional
supportLevel
ServiceDocumentDescription
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_1
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_2
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_3
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_4
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_5
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceDocumentDescription_6
JSON Example
{
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
}string
description
Optional
description
array of string
documentIndexingOptions
Optional
documentIndexingOptions
string
name
Optional
name
object
propertyDescriptions
Optional
propertyDescriptions
integer As int32 As int32
serializedStateSizeLimit
Optional
serializedStateSizeLimit
array of string
serviceCapabilities
Optional
serviceCapabilities
object
serviceRequestRoutes
Optional
serviceRequestRoutes
string
userInterfaceResourcePath
Optional
userInterfaceResourcePath
integer As int64 As int64
versionRetentionFloor
Optional
versionRetentionFloor
integer As int64 As int64
versionRetentionLimit
Optional
versionRetentionLimit
ServiceErrorResponse
JSON Example
{
"details": [
"string"
],
"documentKind": "string",
"errorCode": "integer",
"message": "string",
"messageId": "string",
"stackTrace": [
"string"
],
"statusCode": "integer"
}array of string
details
Optional
details
string
documentKind
Optional
documentKind
integer As int32 As int32
errorCode
Optional
errorCode
string
message
Optional
message
string
messageId
Optional
messageId
array of string
stackTrace
Optional
stackTrace
integer As int32 As int32
statusCode
Optional
statusCode
SocketContext
JSON Example
{
"lastUseTimeMicros": "integer"
}integer As int64 As int64
lastUseTimeMicros
Optional
lastUseTimeMicros
Sort
JSON Example
{
"empty": "boolean",
"sorted": "boolean",
"unsorted": "boolean"
}boolean
empty
Optional
empty
boolean
sorted
Optional
sorted
boolean
unsorted
Optional
unsorted
StackTraceElement
JSON Example
{
"fileName": "string",
"lineNumber": "integer",
"methodName": "string"
}string
fileName
Optional
fileName
integer As int32 As int32
lineNumber
Optional
lineNumber
string
methodName
Optional
methodName
SupervisorCluster
JSON Example
{
"address": "string",
"cpuCapacity": "integer",
"cpuUsed": "integer",
"documentSelfLink": "string",
"endpointLink": "string",
"id": "string",
"memoryCapacity": "integer",
"memoryUsed": "integer",
"moref": "string",
"name": "string",
"registered": "boolean",
"status": "string",
"storageCapacity": "integer",
"storageUsed": "integer",
"updatedMillis": "integer"
}string
address
Optional
address
integer As int64 As int64
cpuCapacity
Optional
cpuCapacity
integer As int64 As int64
cpuUsed
Optional
cpuUsed
string
documentSelfLink
Optional
documentSelfLink
string
endpointLink
Optional
endpointLink
string
id
Optional
id
integer As int64 As int64
memoryCapacity
Optional
memoryCapacity
integer As int64 As int64
memoryUsed
Optional
memoryUsed
string
moref
Optional
moref
string
name
Optional
name
boolean
registered
Optional
registered
string
status
Optional
status
integer As int64 As int64
storageCapacity
Optional
storageCapacity
integer As int64 As int64
storageUsed
Optional
storageUsed
integer As int64 As int64
updatedMillis
Optional
updatedMillis
SupervisorNamespace
JSON Example
{
"address": "string",
"cluster": "string",
"cpuUsed": "integer",
"description": "string",
"documentSelfLink": "string",
"editGroups": "string",
"editUsers": "string",
"endpointLink": "string",
"id": "string",
"memoryUsed": "integer",
"name": "string",
"owner": "string",
"projectId": "string",
"registered": "boolean",
"status": "string",
"storageUsed": "integer",
"updatedMillis": "integer",
"viewGroups": "string",
"viewUsers": "string"
}string
address
Optional
address
string
cluster
Optional
cluster
integer As int64 As int64
cpuUsed
Optional
cpuUsed
string
description
Optional
description
string
documentSelfLink
Optional
documentSelfLink
string
editGroups
Optional
editGroups
string
editUsers
Optional
editUsers
string
endpointLink
Optional
endpointLink
string
id
Optional
id
integer As int64 As int64
memoryUsed
Optional
memoryUsed
string
name
Optional
name
string
owner
Optional
owner
string
projectId
Optional
projectId
boolean
registered
Optional
registered
string
status
Optional
status
integer As int64 As int64
storageUsed
Optional
storageUsed
integer As int64 As int64
updatedMillis
Optional
updatedMillis
string
viewGroups
Optional
viewGroups
string
viewUsers
Optional
viewUsers
SupervisorNamespaceCreateDTO
JSON Example
{
"cluster": "string",
"description": "string",
"editGroups": "string",
"editUsers": "string",
"endpointId": "string",
"name": "string",
"projectId": "string",
"viewGroups": "string",
"viewUsers": "string"
}string
cluster
Optional
cluster
string
description
Optional
description
string
editGroups
Optional
editGroups
string
editUsers
Optional
editUsers
string
endpointId
Optional
endpointId
string
name
Optional
name
string
projectId
Optional
projectId
string
viewGroups
Optional
viewGroups
string
viewUsers
Optional
viewUsers
SupervisorNamespaceSyncRequestDTO
JSON Example
{
"editGroups": "string",
"editUsers": "string",
"viewGroups": "string",
"viewUsers": "string"
}string
editGroups
Optional
editGroups
string
editUsers
Optional
editUsers
string
viewGroups
Optional
viewGroups
string
viewUsers
Optional
viewUsers
SupervisorNamespace_1
JSON Example
{
"address": "string",
"cluster": "string",
"cpuUsed": "integer",
"description": "string",
"documentSelfLink": "string",
"editGroups": "string",
"editUsers": "string",
"endpointLink": "string",
"id": "string",
"memoryUsed": "integer",
"name": "string",
"owner": "string",
"projectId": "string",
"registered": "boolean",
"status": "string",
"storageUsed": "integer",
"updatedMillis": "integer",
"viewGroups": "string",
"viewUsers": "string"
}string
address
Optional
address
string
cluster
Optional
cluster
integer As int64 As int64
cpuUsed
Optional
cpuUsed
string
description
Optional
description
string
documentSelfLink
Optional
documentSelfLink
string
editGroups
Optional
editGroups
string
editUsers
Optional
editUsers
string
endpointLink
Optional
endpointLink
string
id
Optional
id
integer As int64 As int64
memoryUsed
Optional
memoryUsed
string
name
Optional
name
string
owner
Optional
owner
string
projectId
Optional
projectId
boolean
registered
Optional
registered
string
status
Optional
status
integer As int64 As int64
storageUsed
Optional
storageUsed
integer As int64 As int64
updatedMillis
Optional
updatedMillis
object
utilisation
Optional
utilisation
string
viewGroups
Optional
viewGroups
string
viewUsers
Optional
viewUsers
TagState
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_1
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_2
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_3
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_4
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_5
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
TagState_6
JSON Example
{
"deleted": "boolean",
"documentAuthPrincipalLink": "string",
"documentDescription": {
"description": "string",
"documentIndexingOptions": [
"string"
],
"name": "string",
"serializedStateSizeLimit": "integer",
"serviceCapabilities": [
"string"
],
"userInterfaceResourcePath": "string",
"versionRetentionFloor": "integer",
"versionRetentionLimit": "integer"
},
"documentEpoch": "integer",
"documentExpirationTimeMicros": "integer",
"documentKind": "string",
"documentOwner": "string",
"documentSelfLink": "string",
"documentSourceLink": "string",
"documentTransactionId": "string",
"documentUpdateAction": "string",
"documentUpdateTimeMicros": "integer",
"documentVersion": "integer",
"external": "boolean",
"key": "string",
"origins": [
"string"
],
"tenantLinks": [
"string"
],
"value": "string"
}boolean
deleted
Optional
deleted
string
documentAuthPrincipalLink
Optional
documentAuthPrincipalLink
integer As int64 As int64
documentEpoch
Optional
documentEpoch
integer As int64 As int64
documentExpirationTimeMicros
Optional
documentExpirationTimeMicros
string
documentKind
Optional
documentKind
string
documentOwner
Optional
documentOwner
string
documentSelfLink
Optional
documentSelfLink
string
documentSourceLink
Optional
documentSourceLink
string
documentTransactionId
Optional
documentTransactionId
string
documentUpdateAction
Optional
documentUpdateAction
integer As int64 As int64
documentUpdateTimeMicros
Optional
documentUpdateTimeMicros
integer As int64 As int64
documentVersion
Optional
documentVersion
boolean
external
Optional
external
string
key
Optional
key
array of string
origins
Optional
origins
array of string
tenantLinks
Optional
tenantLinks
string
value
Optional
value
Throwable
JSON Example
{
"cause": "Throwable Object",
"stackTrace": [
{
"fileName": "string",
"lineNumber": "integer",
"methodName": "string"
}
]
}
URI
JSON Example
{
"absolute": "boolean",
"authority": "string",
"fragment": "string",
"host": "string",
"opaque": "boolean",
"path": "string",
"port": "integer",
"query": "string",
"rawAuthority": "string",
"rawFragment": "string",
"rawPath": "string",
"rawQuery": "string",
"rawSchemeSpecificPart": "string",
"rawUserInfo": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
}boolean
absolute
Optional
absolute
string
authority
Optional
authority
string
fragment
Optional
fragment
string
host
Optional
host
boolean
opaque
Optional
opaque
string
path
Optional
path
integer As int32 As int32
port
Optional
port
string
query
Optional
query
string
rawAuthority
Optional
rawAuthority
string
rawFragment
Optional
rawFragment
string
rawPath
Optional
rawPath
string
rawQuery
Optional
rawQuery
string
rawSchemeSpecificPart
Optional
rawSchemeSpecificPart
string
rawUserInfo
Optional
rawUserInfo
string
scheme
Optional
scheme
string
schemeSpecificPart
Optional
schemeSpecificPart
string
userInfo
Optional
userInfo
URI_1
JSON Example
{
"authority": "string",
"fragment": "string",
"host": "string",
"path": "string",
"port": "integer",
"query": "string",
"scheme": "string",
"schemeSpecificPart": "string",
"userInfo": "string"
}string
authority
Optional
authority
string
fragment
Optional
fragment
string
host
Optional
host
string
path
Optional
path
integer As int32 As int32
port
Optional
port
string
query
Optional
query
string
scheme
Optional
scheme
string
schemeSpecificPart
Optional
schemeSpecificPart
string
userInfo
Optional
userInfo
X509Certificate
JSON Example
{
"encoded": "string",
"issuerDN": {
"name": "string"
},
"notAfter": "string",
"notBefore": "string",
"publicKey": {
"algorithm": "string",
"encoded": "string",
"format": "string"
},
"serialNumber": "integer",
"sigAlgName": "string",
"sigAlgOID": "string",
"sigAlgParams": "string",
"subjectDN": {
"name": "string"
},
"version": "integer"
}string As byte As byte
encoded
Optional
encoded
string As date-time As date-time
notAfter
Optional
notAfter
string As date-time As date-time
notBefore
Optional
notBefore
integer
serialNumber
Optional
serialNumber
string
sigAlgName
Optional
sigAlgName
string
sigAlgOID
Optional
sigAlgOID
string As byte As byte
sigAlgParams
Optional
sigAlgParams
integer As int32 As int32
version
Optional
version
Node: apidepo-liferay-dxp-v1-be-w-1:8080: