Deployment

An Object

Table of Contents
Note

Drop in one of our language drivers to accelerate your development.
Here are links to some of our popular Cookbooks to help you get started!

Parent

This Deployment is contained within a Platform.

Properties

The following properties are available:

Property Type Default Read-Only Description
_doc string No The primary ID
_system object No Metadata maintained by the system

Methods

The following methods are available:

Analyze

POST /deployments/{deploymentId}/analyze

Parameters

Name Required Type Description
deploymentId true string

Response

{}

Handlers

GET /deployment/handlers

Parameters

This function has no parameters.

Response

{}

Lists Deployment

Retrieves a list of Deployment instances
GET /deployments

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment"
      }
    }
  }
}

Queries for Deployment

Queries for instances of type Deployment
POST /deployments/query

Parameters

Name Required Type Description
sort false object Defines how to sort fields in the result set
skip false number Skips the result set cursor ahead the specified number of records
limit false number Specifies the number of records to be handed back in the result set

Response

{
  "type": "object",
  "description": "Result Map",
  "properties": {
    "total_rows": {
      "type": "number"
    },
    "offset": {
      "type": "number"
    },
    "size": {
      "type": "number"
    },
    "rows": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/resultmap_deployment"
      }
    }
  }
}

Read Deployment

Reads an instance of a Deployment
GET /deployments/{deploymentId}

Parameters

Name Required Type Description
deploymentId true string

Response

{
  "type": "object",
  "extends": "document",
  "description": "Deployment",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  }
}

Retry

POST /deployments/{deploymentId}/retry

Parameters

Name Required Type Description
deploymentId true string

Response

{}

{type}

GET /deployment/handlers/{type}

Parameters

Name Required Type Description
type true string

Response

{}

Schema


{
  "type": "object",
  "extends": "document",
  "description": "Deployment",
  "container": "platform",
  "properties": {
    "_doc": null,
    "_system": null
  },
  "id": "deployment"
}