Jump to

• Request
• Response

Batch Create Change Requests

post

/api/restapi/changeRequest/batch

Send a request to this endpoint to create one or more change requests. An application object will be created for each JSON object provided in the request body.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : List<ApiEntityChangeRequest>

Type: array

Title: List<ApiEntityChangeRequest>

Show Source

• Array of: object ApiEntityChangeRequest
  Title: ApiEntityChangeRequest

  This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.

  • changeRequestId
  • changeRequestCode,projectId
  • changeRequestCode,projectCode,workspaceCode

{
    "title":"List<ApiEntityChangeRequest>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityChangeRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityChangeRequest

Type: object

Title: ApiEntityChangeRequest

This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.

• changeRequestId
• changeRequestCode,projectId
• changeRequestCode,projectCode,workspaceCode

Show Source

• approvalDate: string (date-time)
  Read Only: true

  The date the change request was approved.
• changeRequestCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the change request.
• changeRequestId: integer (int64)
  The unique identifier of the change request.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A summary of the purpose for the change.
• finalizedById: integer (int64)
  The user who accepted the change request.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maxSuffix: integer (int64)
  The maximum value allowed for a code suffix.
• projectBaselineId: integer (int64)
  The unique identifier of the project baseline associated with the change request.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• rejectedByUserId: integer (int64)
  Read Only: true

  The user who rejected the change request.
• rejectedDate: string (date-time)
  Read Only: true

  The date the change request was rejected.
• reopenedByUserId: integer (int64)
  Read Only: true

  The user who reopened the rejected change request.
• reopenedDate: string (date-time)
  Read Only: true

  The date the rejected change request was reopened.
• sourceObjectType(required): string
  Allowed Values: [ "SCOPE_ITEM", "WORK_PACKAGE" ]

  Type of object on which a change request is operating. Changes can run against scope items or work packages.
• status: string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]

  The state of the change request.
  Pending: The change request is submitted and awaiting a decision.
  Approved: The change request was approved.
  Rejected: The change request was not approved.
• type: string
  Allowed Values: [ "CHANGE", "NEW", "TRANSFER" ]

  The type of change.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• withdrawnApprovalByUserId: integer (int64)
  Read Only: true

  The user who withdrew approval of the change request.
• withdrawnApprovalDate: string (date-time)
  Read Only: true

  The date the approved change request was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityChangeRequest",
    "required":[
        "projectId",
        "sourceObjectType"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The type of change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CHANGE",
                "NEW",
                "TRANSFER"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the change request. <br />Pending: The change request is submitted and awaiting a decision. <br />Approved: The change request was approved. <br />Rejected: The change request was not approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED",
                "WITHDRAW_APPROVAL",
                "REOPEN"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A summary of the purpose for the change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finalizedById":{
            "type":"integer",
            "description":"The user who accepted the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "changeRequestId":{
            "type":"integer",
            "description":"The unique identifier of the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectedByUserId":{
            "type":"integer",
            "description":"The user who rejected the change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reopenedByUserId":{
            "type":"integer",
            "description":"The user who reopened the rejected change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectedDate":{
            "type":"string",
            "description":"The date the change request was rejected.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reopenedDate":{
            "type":"string",
            "description":"The date the rejected change request was reopened.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectBaselineId":{
            "type":"integer",
            "description":"The unique identifier of the project baseline associated with the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceObjectType":{
            "type":"string",
            "description":"Type of object on which a change request is operating. Changes can run against scope items or work packages.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SCOPE_ITEM",
                "WORK_PACKAGE"
            ]
        },
        "maxSuffix":{
            "type":"integer",
            "description":"The maximum value allowed for a code suffix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approvalDate":{
            "type":"string",
            "description":"The date the change request was approved.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawnApprovalDate":{
            "type":"string",
            "description":"The date the approved change request was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawnApprovalByUserId":{
            "type":"integer",
            "description":"The user who withdrew approval of the change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "changeRequestCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.<ul><li>changeRequestId</li><li>changeRequestCode,projectId</li><li>changeRequestCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

The object was successfully created.

Body ()

Root Schema : List<ApiEntityChangeRequest>

Type: array

Title: List<ApiEntityChangeRequest>

Show Source

• Array of: object ApiEntityChangeRequest
  Title: ApiEntityChangeRequest

  This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.

  • changeRequestId
  • changeRequestCode,projectId
  • changeRequestCode,projectCode,workspaceCode

{
    "title":"List<ApiEntityChangeRequest>",
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "$ref":"#/components/schemas/ApiEntityChangeRequest",
        "exampleSetFlag":false
    },
    "types":[
        "array"
    ]
}

Nested Schema : ApiEntityChangeRequest

Type: object

Title: ApiEntityChangeRequest

This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.

• changeRequestId
• changeRequestCode,projectId
• changeRequestCode,projectCode,workspaceCode

Show Source

• approvalDate: string (date-time)
  Read Only: true

  The date the change request was approved.
• changeRequestCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified unique identifier of the change request.
• changeRequestId: integer (int64)
  The unique identifier of the change request.
• description: string
  Minimum Length: 0

  Maximum Length: 4000

  A summary of the purpose for the change.
• finalizedById: integer (int64)
  The user who accepted the change request.
• link: string (url)
  Read Only: true

  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• maxSuffix: integer (int64)
  The maximum value allowed for a code suffix.
• projectBaselineId: integer (int64)
  The unique identifier of the project baseline associated with the change request.
• projectCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId(required): integer (int64)
  The unique identifier for the project.The project object can also be identified by its unique criteria.
• rejectedByUserId: integer (int64)
  Read Only: true

  The user who rejected the change request.
• rejectedDate: string (date-time)
  Read Only: true

  The date the change request was rejected.
• reopenedByUserId: integer (int64)
  Read Only: true

  The user who reopened the rejected change request.
• reopenedDate: string (date-time)
  Read Only: true

  The date the rejected change request was reopened.
• sourceObjectType(required): string
  Allowed Values: [ "SCOPE_ITEM", "WORK_PACKAGE" ]

  Type of object on which a change request is operating. Changes can run against scope items or work packages.
• status: string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED", "WITHDRAW_APPROVAL", "REOPEN" ]

  The state of the change request.
  Pending: The change request is submitted and awaiting a decision.
  Approved: The change request was approved.
  Rejected: The change request was not approved.
• type: string
  Allowed Values: [ "CHANGE", "NEW", "TRANSFER" ]

  The type of change.
• updateDate: string (date-time)
  Read Only: true

  Date when the record was last updated.
• withdrawnApprovalByUserId: integer (int64)
  Read Only: true

  The user who withdrew approval of the change request.
• withdrawnApprovalDate: string (date-time)
  Read Only: true

  The date the approved change request was withdrawn.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityChangeRequest",
    "required":[
        "projectId",
        "sourceObjectType"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "type":{
            "type":"string",
            "description":"The type of change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "CHANGE",
                "NEW",
                "TRANSFER"
            ]
        },
        "status":{
            "type":"string",
            "description":"The state of the change request. <br />Pending: The change request is submitted and awaiting a decision. <br />Approved: The change request was approved. <br />Rejected: The change request was not approved.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED",
                "WITHDRAW_APPROVAL",
                "REOPEN"
            ]
        },
        "description":{
            "maxLength":"4000",
            "minLength":"0",
            "type":"string",
            "description":"A summary of the purpose for the change.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "finalizedById":{
            "type":"integer",
            "description":"The user who accepted the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.The project object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "changeRequestId":{
            "type":"integer",
            "description":"The unique identifier of the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectedByUserId":{
            "type":"integer",
            "description":"The user who rejected the change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "reopenedByUserId":{
            "type":"integer",
            "description":"The user who reopened the rejected change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "rejectedDate":{
            "type":"string",
            "description":"The date the change request was rejected.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "reopenedDate":{
            "type":"string",
            "description":"The date the rejected change request was reopened.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectBaselineId":{
            "type":"integer",
            "description":"The unique identifier of the project baseline associated with the change request.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "sourceObjectType":{
            "type":"string",
            "description":"Type of object on which a change request is operating. Changes can run against scope items or work packages.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "SCOPE_ITEM",
                "WORK_PACKAGE"
            ]
        },
        "maxSuffix":{
            "type":"integer",
            "description":"The maximum value allowed for a code suffix.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "approvalDate":{
            "type":"string",
            "description":"The date the change request was approved.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawnApprovalDate":{
            "type":"string",
            "description":"The date the approved change request was withdrawn.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "withdrawnApprovalByUserId":{
            "type":"integer",
            "description":"The user who withdrew approval of the change request.",
            "format":"int64",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "changeRequestCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified unique identifier of the change request.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ChangeRequest object, a unique ChangeRequest object can be identified by the following combinations of the fields.<ul><li>changeRequestId</li><li>changeRequestCode,projectId</li><li>changeRequestCode,projectCode,workspaceCode</li>",
    "exampleSetFlag":false
}

400 Response

Invalid input for the Change Request service. Verify the request contains valid data, then resubmit the request.

Back to Top