Nexus
Nexus APIs
GET
/v1/products/{productId}
Gets a single Product by Id.
Parameters
| Name | In | Required | Description |
|---|---|---|---|
productId |
path | Yes | |
select |
query | No | One or more comma separated fields to select. |
expand |
query | No | Indicates if the response should expand nested objects. |
Responses
200
Example
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
],
"contact": "string",
"created": "string",
"domains": [
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}
],
"members": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": null,
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": null,
"organizationId": 0,
"publicMetadata": null,
"deploymentTargets": [],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"id": 0,
"logs": [
{
"severity": null,
"subscription": null
}
],
"type": "string",
"status": "string",
"created": "string",
"details": "string",
"expires": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
applications
|
nullable | — | — | |
created
|
string (date-time)
|
nullable | The date/time the record was created in UTC. | — |
createdBy
|
string
|
nullable | The identifier of the user or user that created this record. | — |
displayName
|
string
|
nullable |
A short description.
maxLength: 250
|
— |
id
|
integer (int32)
|
nullable | The unique identifier. | — |
isActive
|
boolean
|
nullable | Indicates if the Product is active. This value will control whether specific operations are supported on a Product. | — |
longDescription
|
string
|
nullable |
A longer description.
maxLength: 1000
|
— |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified in UTC. | — |
modifiedBy
|
string
|
nullable | The identifier of the user or user that last modified this record. | — |
name
|
string
|
nullable | The human readable unique name of the product. | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | The Id of the Organization to which this Product belongs. | — |
publicMetadata
|
— | JsonObject primitive | — | |
subscriptions
|
nullable | The associated applications | — | |
url
|
string
|
nullable |
Url to product website
maxLength: 1000
|
— |
Example
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
],
"contact": "string",
"created": "string",
"domains": [
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}
],
"members": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": null,
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": null,
"organizationId": 0,
"publicMetadata": null,
"deploymentTargets": [],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"id": 0,
"logs": [
{
"severity": null,
"subscription": null
}
],
"type": "string",
"status": "string",
"created": "string",
"details": "string",
"expires": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
applications
|
nullable | — | — | |
created
|
string (date-time)
|
nullable | The date/time the record was created in UTC. | — |
createdBy
|
string
|
nullable | The identifier of the user or user that created this record. | — |
displayName
|
string
|
nullable |
A short description.
maxLength: 250
|
— |
id
|
integer (int32)
|
nullable | The unique identifier. | — |
isActive
|
boolean
|
nullable | Indicates if the Product is active. This value will control whether specific operations are supported on a Product. | — |
longDescription
|
string
|
nullable |
A longer description.
maxLength: 1000
|
— |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified in UTC. | — |
modifiedBy
|
string
|
nullable | The identifier of the user or user that last modified this record. | — |
name
|
string
|
nullable | The human readable unique name of the product. | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | The Id of the Organization to which this Product belongs. | — |
publicMetadata
|
— | JsonObject primitive | — | |
subscriptions
|
nullable | The associated applications | — | |
url
|
string
|
nullable |
Url to product website
maxLength: 1000
|
— |
Example
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"isActive": false,
"metadata": {},
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"organizationId": 0,
"publicMetadata": {},
"deploymentTargets": [
{
"details": null,
"application": null
}
],
"userDefaultIsActive": false
}
],
"organization": {
"id": 0,
"name": "string",
"type": "string",
"aliases": [
{
"created": "string",
"systemId": "string",
"systemName": "string",
"organizationId": 0
}
],
"contact": "string",
"created": "string",
"domains": [
{
"domain": "string",
"created": "string",
"domainId": 0,
"modified": "string",
"createdBy": "string",
"isVerified": false,
"modifiedBy": "string",
"organizationId": 0,
"verificationCode": "string",
"verificationMethod": "string",
"ownerOrganizationId": 0,
"authenticationMethod": "string",
"verificationCodeExpires": "string"
}
],
"members": [
{
"id": "string",
"user": null,
"roles": [],
"userId": "string",
"created": "string",
"isGuest": false,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"isMfaRequired": false,
"organizationId": 0,
"organizationName": "string",
"isMembershipMfaRequired": false,
"organizationDisplayName": "string"
}
],
"isActive": false,
"modified": "string",
"products": [
{
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
}
],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [
{
"id": 0,
"name": "string",
"created": "string",
"product": null,
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"productId": 0,
"modifiedBy": "string",
"displayName": "string",
"organization": null,
"organizationId": 0,
"publicMetadata": null,
"deploymentTargets": [],
"userDefaultIsActive": false
}
],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [
{
"id": 0,
"logs": [],
"type": "string",
"status": null,
"created": "string",
"details": "string",
"expires": "string",
"product": null,
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": null,
"sfContractId": "string",
"customMetadata": null,
"organizationId": 0,
"readonlyMetadata": null,
"sfSubscriptionId": "string",
"applicationDeployments": []
}
],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"subscriptions": [
{
"id": 0,
"logs": [
{
"severity": null,
"subscription": null
}
],
"type": "string",
"status": "string",
"created": "string",
"details": "string",
"expires": "string",
"product": {
"id": 0,
"url": "string",
"name": "string",
"created": "string",
"isActive": false,
"metadata": null,
"modified": "string",
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"organization": null,
"subscriptions": [],
"organizationId": 0,
"publicMetadata": null,
"longDescription": "string"
},
"modified": "string",
"createdBy": "string",
"isEnabled": false,
"productId": 0,
"modifiedBy": "string",
"statusText": "string",
"description": "string",
"sfLicenseId": "string",
"organization": {
"id": 0,
"name": "string",
"type": null,
"aliases": [],
"contact": "string",
"created": "string",
"domains": [],
"members": [],
"isActive": false,
"modified": "string",
"products": [],
"createdBy": "string",
"modifiedBy": "string",
"displayName": "string",
"applications": [],
"crmAccountId": "string",
"isMfaRequired": false,
"isSelfService": false,
"subscriptions": [],
"technicalContact": "string",
"isEnabledForPreviewFeatures": false,
"isDomainVerificationRequired": false
},
"sfContractId": "string",
"customMetadata": {},
"organizationId": 0,
"readonlyMetadata": {},
"sfSubscriptionId": "string",
"applicationDeployments": [
{
"application": null,
"subscription": null,
"customMetadata": null,
"deploymentTarget": null,
"readonlyMetadata": null
}
]
}
],
"organizationId": 0,
"publicMetadata": {},
"longDescription": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
applications
|
nullable | — | — | |
created
|
string (date-time)
|
nullable | The date/time the record was created in UTC. | — |
createdBy
|
string
|
nullable | The identifier of the user or user that created this record. | — |
displayName
|
string
|
nullable |
A short description.
maxLength: 250
|
— |
id
|
integer (int32)
|
nullable | The unique identifier. | — |
isActive
|
boolean
|
nullable | Indicates if the Product is active. This value will control whether specific operations are supported on a Product. | — |
longDescription
|
string
|
nullable |
A longer description.
maxLength: 1000
|
— |
metadata
|
— | JsonObject primitive | — | |
modified
|
string (date-time)
|
nullable | The date/time the record was last modified in UTC. | — |
modifiedBy
|
string
|
nullable | The identifier of the user or user that last modified this record. | — |
name
|
string
|
nullable | The human readable unique name of the product. | — |
organization
|
— | Represents an Organization | — | |
organizationId
|
integer (int32)
|
nullable | The Id of the Organization to which this Product belongs. | — |
publicMetadata
|
— | JsonObject primitive | — | |
subscriptions
|
nullable | The associated applications | — | |
url
|
string
|
nullable |
Url to product website
maxLength: 1000
|
— |
404
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Example
{
"type": "string",
"title": "string",
"detail": "string",
"status": 0,
"instance": "string"
}Schema
| Name | Type | Attributes | Description | Extensions |
|---|---|---|---|---|
detail
|
string
|
nullable | — | — |
instance
|
string
|
nullable | — | — |
status
|
integer (int32)
|
nullable | — | — |
title
|
string
|
nullable | — | — |
type
|
string
|
nullable | — | — |
Security
Authentication is required for this operation.
Source: default
Requirements (any one option may satisfy)
- Bearer and ApplicationToken
- Basic