1. REST API for Oracle Fusion Cloud Project Management
  2. Tasks
  3. Change Orders
  4. Change Participants

Get all participants for change order

get

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

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • ChangeDocumentResourceAltKey: Finds a change participant with the specified change order ID, and logged in user ID.
      Finder Variables:
      • ParticipantResourceId; integer.
    • PrimaryKey: Finds a participant for the change order with the specified primary key.
      Finder Variables:
      • ParticipantId; integer; The unique identifier of the participant for the change order.
    • RowFinder: Finds all change participants with the specified resource ID, change order ID, and assessment option.
      Finder Variables:
      • RejectDate; integer; Date when change order was rejected.
    • findByParticapantId: Finds all change participants with the specified participant ID.
      Finder Variables:
      • ParticipantId; integer; The unique identifier of the participant for a change order.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ApproveComments; string; Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
    • ApproveFlag; boolean; 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; Approval status of participant for a change order. Valid values are In Progress, Completed, and Rejected.
    • AssessmentComments; string; Assessment comments by participant for a change order.
    • AssessmentFlag; boolean; Indicates whether a participant is an assessor on the change order. Valid values are Y and N. The default value is N.
    • AssessmentStatus; string; Assessment status of assessor for a change order. Valid values are In Progress and Completed.
    • ImplementationComments; string; Implementation comments by participant for a change order.
    • ImplementationFlag; boolean; Indicates whether a participant is an implementor on the change order. Valid values are Y and N. The default value is N.
    • ImplementationStatus; string; Implementation status of participant for a change order. Valid values are In Progress and Completed.
    • ParticipantEmail; string; Email of the change order participant.
    • ParticipantId; integer; Unique identifier of the change order participant.
    • ParticipantName; string; Name of the change order participant.
    • ParticipantResourceId; integer; Resource identifier of the change order participant.
    • RejectDate; string; Date when change order was rejected. Calculated by application.
    • RejectType; string; 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; Review comments by participant for a change order.
    • ReviewFlag; boolean; Indicates whether a participant is a reviewer on the change order. Valid values are Y and N. The default value is N.
    • ReviewStatus; string; Review status of participant for a change order. Valid values are In Progress and Completed.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : changeOrders-ChangeParticipants-item-response
Type: object
Show Source
  • Title: Approval or Rejection Comments
    Maximum Length: 2000
    Approval or rejection comments by participant for a change order. Mandatory for rejecting the change order.
  • 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.
  • 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.
  • Title: Assessment Comments
    Maximum Length: 2000
    Assessment comments by participant for a change order.
  • 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.
  • Title: Assessor Status
    Maximum Length: 30
    Default Value: N
    Assessment status of assessor for a change order. Valid values are In Progress and Completed.
  • Title: Implementation Comments
    Maximum Length: 2000
    Implementation comments by participant for a change order.
  • 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.
  • 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
  • Title: Participant Email
    Email of the change order participant.
  • Title: Participant Id
    Read Only: true
    Unique identifier of the change order participant.
  • Title: Participant Name
    Name of the change order participant.
  • Title: Participant Resource Id
    Resource identifier of the change order participant.
  • Title: Rejection Date
    Date when change order was rejected. Calculated by application.
  • 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.
  • Title: Review Comments
    Maximum Length: 2000
    Review comments by participant for a change order.
  • 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.
  • Title: Reviewer Status
    Maximum Length: 30
    Default Value: N
    Review status of participant for a change order. Valid values are In Progress and Completed.
Back to Top

Examples

The following example shows how to get all the change participants for a change orders by submitting a GET request on the REST resource using cURL.

curl --user ppm_cloud_user https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/changeOrders/300100124745706/child/ChangeParticipants

Example of Response Body

The following example shows the contents of the response body in JSON format which includes all the change participants for the changer order with change document ID 300100124745706.

{
"items": [
  {
"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": "prj_mary_smith_in_grp@oracle.com",
}
],
}
Back to Top