Deployment Record

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 Record 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:

Lists Deployment Record

Retrieves a list of Deployment Record instances
GET /deployment/records

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
This method supports pagination.

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-record"
      }
    }
  }
}

Queries for Deployment Record

Queries for instances of type Deployment Record
POST /deployment/records/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
This method supports pagination.

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-record"
      }
    }
  }
}

Read Deployment Record

Reads an instance of a Deployment Record
GET /deployment/records/{deploymentRecordId}

Parameters

Name Required Type Description
deploymentRecordId true string

Response

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

Schema


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