Jump to

• Request
• Response
• Examples

Create participants for a change order

post

/fscmRestApi/resources/11.13.18.05/changeOrders/{ChangeDocumentId}/child/ChangeParticipants

Request

Path Parameters

• ChangeDocumentId(required): integer(int64)
  Unique identifier of a project change order. Mandatory for PATCH operation.

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ApproveComments: string
  Title: Approval or Rejection Comments

  Maximum Length: 2000

  Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
• ApproveFlag: boolean
  Title: Approver Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.
• ApproveStatus: string
  Title: Approver Status

  Maximum Length: 30

  Default Value: N

  Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.
• AssessmentComments: string
  Title: Assessment Comments

  Maximum Length: 2000

  Assessment comments by participant for a change order.
• AssessmentFlag: boolean
  Title: Assessor Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.
• AssessmentStatus: string
  Title: Assessor Status

  Maximum Length: 30

  Default Value: N

  Assessment status of assessor for a change order. Valid values are In Progress and Completed.
• ImplementationComments: string
  Title: Implementation Comments

  Maximum Length: 2000

  Implementation comments by participant for a change order.
• ImplementationFlag: boolean
  Title: Implementor Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.
• ImplementationStatus: string
  Title: Implementor Status

  Maximum Length: 30

  Default Value: N

  Implementation status of participant for a change order. Valid values are In Progress and Completed.
• ParticipantEmail: string
  Title: Participant Email

  Email of the change order participant.
• ParticipantName: string
  Title: Participant Name

  Name of the change order participant.
• ParticipantResourceId: integer (int64)
  Title: Participant Resource ID

  Resource identifier of the change order participant.
• RejectDate: string (date)
  Title: Rejection Date

  Date when change order was rejected. Calculated by application.
• RejectType: string
  Title: Rejection Reason Code

  Maximum Length: 30

  The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.
• ReviewComments: string
  Title: Review Comments

  Maximum Length: 2000

  Review comments by participant for a change order.
• ReviewFlag: boolean
  Title: Reviewer Indicator

  Maximum Length: 2

  Default Value: true

  Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.
• ReviewStatus: string
  Title: Reviewer Status

  Maximum Length: 30

  Default Value: N

  Review status of participant for a change order. Valid values are In Progress and Completed.

{
    "type":"object",
    "properties":{
        "ApproveComments":{
            "title":"Approval or Rejection Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.",
            "nullable":true
        },
        "ApproveFlag":{
            "title":"Approver Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.",
            "nullable":false,
            "default":false
        },
        "ApproveStatus":{
            "title":"Approver Status",
            "maxLength":30,
            "type":"string",
            "description":"Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.",
            "nullable":true,
            "default":"N"
        },
        "AssessmentComments":{
            "title":"Assessment Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Assessment comments by participant for a change order.",
            "nullable":true
        },
        "AssessmentFlag":{
            "title":"Assessor Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":false
        },
        "AssessmentStatus":{
            "title":"Assessor Status",
            "maxLength":30,
            "type":"string",
            "description":"Assessment status of assessor for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N"
        },
        "ImplementationComments":{
            "title":"Implementation Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Implementation comments by participant for a change order.",
            "nullable":true
        },
        "ImplementationFlag":{
            "title":"Implementor Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":false
        },
        "ImplementationStatus":{
            "title":"Implementor Status",
            "maxLength":30,
            "type":"string",
            "description":"Implementation status of participant for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N"
        },
        "ParticipantEmail":{
            "title":"Participant Email",
            "type":"string",
            "description":"Email of the change order participant.",
            "nullable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "type":"string",
            "description":"Name of the change order participant.",
            "nullable":true
        },
        "ParticipantResourceId":{
            "title":"Participant Resource ID",
            "type":"integer",
            "description":"Resource identifier of the change order participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RejectDate":{
            "title":"Rejection Date",
            "type":"string",
            "description":"Date when change order was rejected. Calculated by application.",
            "format":"date",
            "nullable":true
        },
        "RejectType":{
            "title":"Rejection Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.",
            "nullable":true
        },
        "ReviewComments":{
            "title":"Review Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Review comments by participant for a change order.",
            "nullable":true
        },
        "ReviewFlag":{
            "title":"Reviewer Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":true
        },
        "ReviewStatus":{
            "title":"Reviewer Status",
            "maxLength":30,
            "type":"string",
            "description":"Review status of participant for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : changeOrders-ChangeParticipants-item-response

Type: object

Show Source

• ApproveComments: string
  Title: Approval or Rejection Comments

  Maximum Length: 2000

  Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
• ApproveFlag: boolean
  Title: Approver Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.
• ApproveStatus: string
  Title: Approver Status

  Maximum Length: 30

  Default Value: N

  Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.
• AssessmentComments: string
  Title: Assessment Comments

  Maximum Length: 2000

  Assessment comments by participant for a change order.
• AssessmentFlag: boolean
  Title: Assessor Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.
• AssessmentStatus: string
  Title: Assessor Status

  Maximum Length: 30

  Default Value: N

  Assessment status of assessor for a change order. Valid values are In Progress and Completed.
• ImplementationComments: string
  Title: Implementation Comments

  Maximum Length: 2000

  Implementation comments by participant for a change order.
• ImplementationFlag: boolean
  Title: Implementor Indicator

  Maximum Length: 2

  Default Value: false

  Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.
• ImplementationStatus: string
  Title: Implementor Status

  Maximum Length: 30

  Default Value: N

  Implementation status of participant for a change order. Valid values are In Progress and Completed.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ParticipantEmail: string
  Title: Participant Email

  Email of the change order participant.
• ParticipantId: integer (int64)
  Title: Participant ID

  Read Only: true

  Unique identifier of the change order participant.
• ParticipantName: string
  Title: Participant Name

  Name of the change order participant.
• ParticipantResourceId: integer (int64)
  Title: Participant Resource ID

  Resource identifier of the change order participant.
• RejectDate: string (date)
  Title: Rejection Date

  Date when change order was rejected. Calculated by application.
• RejectType: string
  Title: Rejection Reason Code

  Maximum Length: 30

  The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.
• ReviewComments: string
  Title: Review Comments

  Maximum Length: 2000

  Review comments by participant for a change order.
• ReviewFlag: boolean
  Title: Reviewer Indicator

  Maximum Length: 2

  Default Value: true

  Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.
• ReviewStatus: string
  Title: Reviewer Status

  Maximum Length: 30

  Default Value: N

  Review status of participant for a change order. Valid values are In Progress and Completed.

{
    "type":"object",
    "properties":{
        "ApproveComments":{
            "title":"Approval or Rejection Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ApproveFlag":{
            "title":"Approver Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an approver on the change order. Valid values are Y, N, and R. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ApproveStatus":{
            "title":"Approver Status",
            "maxLength":30,
            "type":"string",
            "description":"Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "AssessmentComments":{
            "title":"Assessment Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Assessment comments by participant for a change order.",
            "nullable":true,
            "x-queryable":true
        },
        "AssessmentFlag":{
            "title":"Assessor Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "AssessmentStatus":{
            "title":"Assessor Status",
            "maxLength":30,
            "type":"string",
            "description":"Assessment status of assessor for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ImplementationComments":{
            "title":"Implementation Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Implementation comments by participant for a change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ImplementationFlag":{
            "title":"Implementor Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ImplementationStatus":{
            "title":"Implementor Status",
            "maxLength":30,
            "type":"string",
            "description":"Implementation status of participant for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "ParticipantEmail":{
            "title":"Participant Email",
            "type":"string",
            "description":"Email of the change order participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantId":{
            "title":"Participant ID",
            "type":"integer",
            "description":"Unique identifier of the change order participant.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ParticipantName":{
            "title":"Participant Name",
            "type":"string",
            "description":"Name of the change order participant.",
            "nullable":true,
            "x-queryable":true
        },
        "ParticipantResourceId":{
            "title":"Participant Resource ID",
            "type":"integer",
            "description":"Resource identifier of the change order participant.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RejectDate":{
            "title":"Rejection Date",
            "type":"string",
            "description":"Date when change order was rejected. Calculated by application.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "RejectType":{
            "title":"Rejection Reason Code",
            "maxLength":30,
            "type":"string",
            "description":"The code of the rejection type for a change order. Mandatory for rejecting the change order. Valid values are INSUFFICIENT_INFORMATION, OTHER, SCOPE_REDUCTION, and UNACCEPTABLE_RISK.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewComments":{
            "title":"Review Comments",
            "maxLength":2000,
            "type":"string",
            "description":"Review comments by participant for a change order.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewFlag":{
            "title":"Reviewer Indicator",
            "maxLength":2,
            "type":"boolean",
            "description":"Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "ReviewStatus":{
            "title":"Reviewer Status",
            "maxLength":30,
            "type":"string",
            "description":"Review status of participant for a change order. Valid values are In Progress and Completed.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to create participants for a change order by submitting a POST request on the REST resource using cURL.

curl --user ppm_cloud_user -X POST -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/changeOrders/300100124745706/child/ChangeParticipants

Example of Request Body

The following example shows the request body to create a new participant for a change order that is associated to the project with project ID 300100125163003.

{
    "ParticipantName" : "Mary Smith",
    "ParticipantEmail" : "[e-mail]",
    "AssessmentFlag" : "Y",
    "AssessmentStatus" : "N",
    "ReviewFlag" : "Y",
    "ReviewStatus" : "N",
    "ApproveFlag" : "Y",
    "ApproveStatus" : "Y",
    "ImplementationFlag" : "Y",
    "ImplementationStatus" : "Y",
    "AssessmentComments" : null,
    "ReviewComments" : null,
    "ApproveComments" : null,
    "ImplementationComments" : null,
    "RejectType" : null,
    "RejectDate" : null
    }

Example of Response Body

The following shows an example of the response body in JSON format.

{
"ParticipantId": 300100124745939,
"ParticipantResourceId": 300100023180814,
"ChangeDocumentId": 300100124745706,
"AssessmentFlag": true,
"AssessmentStatus": "InProgress",
"ReviewFlag": true,
"ReviewStatus": "InProgress",
"ApproveFlag": true,
"ApproveStatus": "Completed",
"ImplementationFlag": true,
"ImplementationStatus": "InProgress",
"AssessmentComments": null,
"ReviewComments": null,
"ApproveComments": null,
"ImplementationComments": null,
"RejectType": null,
"RejectDate": null,
"ParticipantName": "Mary Smith",
"ParticipantEmail": "[e-mail]",
}

Back to Top