Deployment Package

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 Package 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 Package

Retrieves a list of Deployment Package instances
GET /deployment/packages

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

Queries for Deployment Package

Queries for instances of type Deployment Package
POST /deployment/packages/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-package"
      }
    }
  }
}

Read Deployment Package

Reads an instance of a Deployment Package
GET /deployment/packages/{deploymentPackageId}

Parameters

Name Required Type Description
deploymentPackageId true string

Response

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

Schema


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