Show Source

• [0]: object ApiEntityChangeRequest

{
    "title":"List<ApiEntityChangeRequest>",
    "type":"array",
    "items":{
        "$ref":"#/definitions/ApiEntityChangeRequest"
    }
}

Show Source

• changeRequestId(optional): integer(int64)
  The unique identifier of the change request.
• description(optional): string
  A summary of the purpose for the change.
• finalizedById(optional): integer(int64)
  The person who accepts or rejects the change.
• itemCode: string
  The ID of the change request.
• itemPrefix(optional): string
  The auto numbering prefix of a code.
• itemSuffix(optional): integer(int64)
  The auto numbering suffix of a code.
• link(optional): string(url)
  Read Only: true
• maxSuffix(optional): integer(int64)
  The maximum value allowed for a code suffix.
• projectBaselineId(optional): integer(int64)
  The unique identifier of the project baseline associated with the change request.
• projectId(optional): integer(int64)
  The ID for the project for which this change request is associated.
• sourceObjectType(optional): 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(optional): string
  Allowed Values: [ "PENDING", "APPROVED", "REJECTED" ]

  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(optional): string
  Allowed Values: [ "CHANGE", "NEW", "TRANSFER" ]

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

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.

{
    "type":"object",
    "required":[
        "itemCode"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "type":{
            "type":"string",
            "description":"The type of change.",
            "enum":[
                "CHANGE",
                "NEW",
                "TRANSFER"
            ]
        },
        "description":{
            "type":"string",
            "description":"A summary of the purpose for the change."
        },
        "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.",
            "enum":[
                "PENDING",
                "APPROVED",
                "REJECTED"
            ]
        },
        "itemCode":{
            "type":"string",
            "description":"The ID of the change request."
        },
        "itemSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The auto numbering suffix of a code."
        },
        "itemPrefix":{
            "type":"string",
            "description":"The auto numbering prefix of a code."
        },
        "maxSuffix":{
            "type":"integer",
            "format":"int64",
            "description":"The maximum value allowed for a code suffix."
        },
        "projectBaselineId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the project baseline associated with the change request."
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The ID for the project for which this change request is associated."
        },
        "changeRequestId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of the change request."
        },
        "sourceObjectType":{
            "type":"string",
            "description":"Type of object on which a change request is operating. Changes can run against scope items or work packages.",
            "enum":[
                "SCOPE_ITEM",
                "WORK_PACKAGE"
            ]
        },
        "finalizedById":{
            "type":"integer",
            "format":"int64",
            "description":"The person who accepts or rejects the change."
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}