Jump to

• Request
• Response
• Examples

Update an approver of a gate

patch

/fscmRestApi/resources/11.13.18.05/workPlanTemplates/{WorkPlanTemplateId}/child/Tasks/{TaskId}/child/GateApprovers/{ApprovalId}

Request

Path Parameters

• ApprovalId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• TaskId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• WorkPlanTemplateId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• GateApproverEmail: string
  Title: Gate Approver Email

  Email address of the gate approver.
• GateApproverId: integer (int64)
  Title: Gate Approver ID

  Unique identifier of the gate approver.
• GateApproverName: string
  Title: Gate Approver Name

  Name of the gate approver.

{
    "type":"object",
    "properties":{
        "GateApproverName":{
            "title":"Gate Approver Name",
            "type":"string",
            "description":"Name of the gate approver.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverEmail",
                    "GateApproverId"
                ]
            }
        },
        "GateApproverId":{
            "title":"Gate Approver ID",
            "type":"integer",
            "description":"Unique identifier of the gate approver.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "GateApproverEmail":{
            "title":"Gate Approver Email",
            "type":"string",
            "description":"Email address of the gate approver.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverId"
                ]
            }
        }
    }
}

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 : workPlanTemplates-Tasks-GateApprovers-item-response

Type: object

Show Source

• ApprovalId: integer (int64)
  Title: Approval ID

  Read Only: true

  Unique identifier of the Gate Approver. Value is auto-generated.
• GateApproverEmail: string
  Title: Gate Approver Email

  Email address of the gate approver.
• GateApproverId: integer (int64)
  Title: Gate Approver ID

  Unique identifier of the gate approver.
• GateApproverName: string
  Title: Gate Approver Name

  Name of the gate approver.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ApprovalId":{
            "title":"Approval ID",
            "type":"integer",
            "description":"Unique identifier of the Gate Approver. Value is auto-generated.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "GateApproverName":{
            "title":"Gate Approver Name",
            "type":"string",
            "description":"Name of the gate approver.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverEmail",
                    "GateApproverId"
                ]
            }
        },
        "GateApproverId":{
            "title":"Gate Approver ID",
            "type":"integer",
            "description":"Unique identifier of the gate approver.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "GateApproverEmail":{
            "title":"Gate Approver Email",
            "type":"string",
            "description":"Email address of the gate approver.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "GateApproverId"
                ]
            }
        }
    }
}

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 update an approver of a gate in a work plan template by submitting a PATCH request on the REST resource using cURL.

curl --user ppm_cloud_user -X PATCH -d @example_request_payload.json --header "Content-Type: application/json" https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369459/child/GateApprovers/100100148369489

Request Body Example

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

{
"GateApproverName": "George White"
}

Response Body Example

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

{
"ApprovalId": 100100148369489,
"GateApproverName": "George White",
"GateApproverEmail": "[e-mail]",
"links": [
{
"rel": "self",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369459/child/GateApprovers/100100148369489",
"name": "GateApprovers",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369459/child/GateApprovers/100100148369489",
"name": "GateApprovers",
"kind": "item"
},
{
"rel": "parent",
"href": "https://your_organization.com:port/fscmRestApi/resources/11.13.18.05/workPlanTemplates/100100148369454/child/Tasks/100100148369459",
"name": "Tasks",
"kind": "item"
}
]
}

Back to Top