Nexus

Nexus APIs

PATCH /v1/subscriptions/{subscriptionId}/application-deployments/{applicationDeploymentId}

Updates an application deployment

Parameters
Name In Required Description
subscriptionId path Yes
applicationDeploymentId path Yes
Request body
Request payload
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Example
{
  "name": "string",
  "status": "string",
  "displayName": "string",
  "maxUserCount": 0,
  "configuration": "string",
  "customMetadata": {},
  "statusResolution": "string"
}
Schema
Name Type Attributes Description Extensions
configuration deprecated string nullable Json configuration details
customMetadata JsonObject primitive
displayName string nullable Display name of the deployment
maxUserCount integer (int32) nullable
name string nullable Logical name of the deployment
status string nullable
statusResolution string nullable
Responses
200
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
Example
{
  "id": 0,
  "name": "string",
  "steps": [
    {
      "id": "string",
      "key": "string",
      "status": "string",
      "message": "string",
      "statusResolution": "string",
      "applicationDeploymentId": 0
    }
  ],
  "status": "string",
  "created": "string",
  "modified": "string",
  "createdBy": "string",
  "modifiedBy": "string",
  "application": {
    "id": 0,
    "name": "string",
    "created": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "isActive": false,
    "metadata": {},
    "modified": "string",
    "createdBy": "string",
    "productId": 0,
    "modifiedBy": "string",
    "displayName": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "country": "string",
        "created": "string",
        "details": null,
        "isActive": false,
        "modified": "string",
        "createdBy": "string",
        "publicUrl": "string",
        "modifiedBy": "string",
        "application": null,
        "description": "string",
        "displayName": "string",
        "environment": "string",
        "applicationId": 0
      }
    ],
    "userDefaultIsActive": false
  },
  "displayName": "string",
  "maxUserCount": 0,
  "subscription": {
    "id": 0,
    "logs": [
      {
        "id": 0,
        "created": "string",
        "modified": "string",
        "severity": null,
        "createdBy": "string",
        "logMessage": "string",
        "modifiedBy": "string",
        "subscription": null,
        "subscriptionId": 0
      }
    ],
    "type": "string",
    "status": "string",
    "created": "string",
    "details": "string",
    "expires": "string",
    "product": {
      "id": 0,
      "url": "string",
      "name": "string",
      "created": "string",
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "modifiedBy": "string",
      "displayName": "string",
      "applications": [],
      "organization": {
        "type": null
      },
      "subscriptions": [],
      "organizationId": 0,
      "publicMetadata": {},
      "longDescription": "string"
    },
    "modified": "string",
    "createdBy": "string",
    "isEnabled": false,
    "productId": 0,
    "modifiedBy": "string",
    "statusText": "string",
    "description": "string",
    "sfLicenseId": "string",
    "organization": {
      "id": 0,
      "name": "string",
      "type": "string",
      "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": [
      {
        "id": 0,
        "name": "string",
        "steps": [],
        "status": "string",
        "created": "string",
        "modified": "string",
        "createdBy": "string",
        "modifiedBy": "string",
        "application": null,
        "displayName": "string",
        "maxUserCount": 0,
        "subscription": null,
        "applicationId": 0,
        "configuration": "string",
        "customMetadata": null,
        "subscriptionId": 0,
        "deploymentTarget": null,
        "readonlyMetadata": null,
        "statusResolution": "string",
        "deploymentTargetId": 0
      }
    ]
  },
  "applicationId": 0,
  "configuration": "string",
  "customMetadata": {},
  "subscriptionId": 0,
  "deploymentTarget": {
    "id": 0,
    "name": "string",
    "country": "string",
    "created": "string",
    "details": {},
    "isActive": false,
    "modified": "string",
    "createdBy": "string",
    "publicUrl": "string",
    "modifiedBy": "string",
    "application": {
      "id": 0,
      "name": "string",
      "created": "string",
      "product": {
        "metadata": null,
        "organization": null,
        "publicMetadata": null
      },
      "isActive": false,
      "metadata": {},
      "modified": "string",
      "createdBy": "string",
      "productId": 0,
      "modifiedBy": "string",
      "displayName": "string",
      "organization": {
        "type": null
      },
      "organizationId": 0,
      "publicMetadata": {},
      "deploymentTargets": [],
      "userDefaultIsActive": false
    },
    "description": "string",
    "displayName": "string",
    "environment": "string",
    "applicationId": 0
  },
  "readonlyMetadata": {},
  "statusResolution": "string",
  "deploymentTargetId": 0
}
Schema
Name Type Attributes Description Extensions
application
applicationId integer (int32) Application Id
configuration string nullable Json configuration details
created string (date-time) nullable Date created
createdBy string nullable Created By
customMetadata JsonObject primitive
deploymentTarget
deploymentTargetId integer (int32) nullable Deployment Target Id
displayName string nullable Display name of the deployment
id integer (int32) nullable A system assigned unique identifier.
maxUserCount integer (int32) Application deployment users
modified string (date-time) nullable Date modified
modifiedBy string nullable Modified By
name string nullable Logical name of the deployment
readonlyMetadata JsonObject primitive
status string nullable Status
statusResolution string nullable Status Resolution
steps nullable
subscription Represents a subscription
subscriptionId integer (int32) Subscription Id
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
Security

Authentication is required for this operation.

Source: default

Requirements (any one option may satisfy)

  • Bearer and ApplicationToken
  • Basic