version resource

Resource that manages application versions and component versions.

JSON request templates

Some commands in this resource generate JSON output in multiple formats, as specified by the format parameter. These output formats include different subsets of properties for the requested elements, as appropriate for different use cases. The included properties for each format are described in the JSON templates below.

TEMPLATE_ROOT

{
  "automated": "Whether the version comes from an 
  integration (true or false)",
  "dateCreated": "Timestamp that represents the date when 
  the version was created",
  "description": "Version description",
  "ghostedDate": "Timestamp that represents the date when 
  the version was deleted. If greater than 0, the version 
  has been removed.",
  "id": "Version ID",
  "name": "Version name",
  "version": "Version number"
}

list

{
  "application": "(See: application TEMPLATE_ROOT)",
  "automated": "Whether the version comes from an 
  integration (true or false)",
  "children": "[Array of component versions (See: version 
  TEMPLATE_LIST_COMPONENT_VERSION)]",
  "dateCreated": "Timestamp that represents the date when 
  the version was created",
  "description": "Version description",
  "ghostedDate": "Timestamp that represents the date when 
  the version was deleted. If greater than 0, the version 
  has been removed.",
  "id": "Version ID",
  "name": "Version name",
  "version": "Version number",
  "versionStatuses": [{
    "dateCreated": "Timestamp that represents the date 
  when the Version Status has been created.",
    "id": "VersionStatus ID"
  }]
}

detail

{
  "application": "(See: application TEMPLATE_ROOT)",
  "automated": "Whether the version comes from an 
  integration (true or false)",
  "children": "[Array of component versions (See: version 
  TEMPLATE_LIST_COMPONENT_VERSION)]",
  "dateCreated": "Timestamp that represents the date when 
  the version was created",
  "description": "Version description",
  "ghostedDate": "Timestamp that represents the date when 
  the version was deleted. If greater than 0, the version 
  has been removed.",
  "id": "Version ID",
  "name": "Version name",
  "version": "Version number",
  "versionStatuses": [{
    "attachments": [{
      "dateCreated": "Timestamp that represents the date 
  when the Comment has been created.",
      "fileName": "name of the attachment file",
      "id": "Attachment ID",
      "userId": "User ID"
    }],
    "comments": [{
      "comment": "Comment content",
      "dateCreated": "Timestamp that represents the date 
  when the Comment has been created.",
      "id": "Comment ID",
      "userId": "User ID"
    }],
    "dateCreated": "Timestamp that represents the date 
  when the Version Status has been created.",
    "id": "VersionStatus ID"
  }]
}

TEMPLATE_LIST_COMPONENT_VERSION

{
  "application": "(See: application TEMPLATE_ROOT)",
  "automated": "Whether the version comes from an 
  integration (true or false)",
  "dateCreated": "Timestamp that represents the date when 
  the version was created",
  "description": "Version description",
  "ghostedDate": "Timestamp that represents the date when 
  the version was deleted. If greater than 0, the version 
  has been removed.",
  "id": "Version ID",
  "name": "Version name",
  "version": "Version number"
}

Feedback