Endpoint
/api/v2/tenants/{tenantId}/changeRequests/{changeRequestId}/responses
Path Parameters
tenantId
string

Describes the clientId of the tenant

changeRequestId
string

Unique Identifier (UUID) of change request

attachments
array

(Optional) Attachments for the particular response.

attachments.file
attachments.name
createdDate
string

creator
object

creator.email
creator.firstName
creator.id
creator.lastName
creator.loginName
creator.phoneNumber
description
string

Short summary describing the response.

hasAttachments
boolean

internal
string

(Optional) Represents the visibility of the response: Setting internal=true represents visibility of response within the organization Setting internal=false represents visibility of response to all users

tags
string

(Optional) Labels attached to the response.

{
  "attachments": [
    {
      "file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
      "name": "file-1.txt"
    },
    {
      "file": "U2FtcGxlIFRleHQgZmlsZS0gdGVzdGluZyB3aXRoIGF0dGFjaG1lbnQ=",
      "name": "file-2.txt"
    }
  ],
  "creator": {
    "id": "USR0000002146",
    "loginName": "FSSL-API-Lab-User-1"
  },
  "description": "Change Request Attachment",
  "internal": "false",
  "tags": "API, Change Request"
}

Responses

OK

attachments
array

(Optional) Attachments for the particular response.

attachments.file
attachments.name
createdDate
string

creator
object

creator.email
creator.firstName
creator.id
creator.lastName
creator.loginName
creator.phoneNumber
description
string

Short summary describing the response.

hasAttachments
boolean

internal
string

(Optional) Represents the visibility of the response: Setting internal=true represents visibility of response within the organization Setting internal=false represents visibility of response to all users

tags
string

(Optional) Labels attached to the response.

{
  "attachments": [
    {
      "contentURL": "https://\u003capi-url\u003e/api/v2/tenants/client_1000/changeRequests/CHG0000001111/responses/1901/resources/96",
      "createdDate": "2016-03-29T10:15:55+0000",
      "id": 96,
      "name": "file-1.txt"
    },
    {
      "contentURL": "https://\u003capi-url\u003e/api/v2/tenants/client_1000/changeRequests/CHG0000001111/responses/1901/resources/97",
      "createdDate": "2016-03-29T10:15:55+0000",
      "id": 97,
      "name": "file-2.txt"
    }
  ],
  "createdDate": "2016-03-29T10:15:55+0000",
  "creator": {
    "email": "fssl.user@gmail.com",
    "firstName": "FSSL",
    "id": "USR0000002146",
    "lastName": "API-Lab",
    "loginName": "FSSL-API-Lab-User-1"
  },
  "description": "Change Request Attachment",
  "hasAttachments": true,
  "internal": "false",
  "tags": "API,Change Request"
}