Jump to

• Request
• Response

Include Ad hoc approvers

post

/fscmRestApi/resources/11.13.18.05/workflowNotificationContents/action/addApprovers

Allows users to add Ad hoc approvers to an approval sequence using the preview approvals functionality.

Request

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/vnd.oracle.adf.action+json

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• adhocApproverList: array adhocApproverList
  A list of attributes to add approvers to the approval process. The list includes newAssigneeUsername, anchorUsername, anchorTypeCode, and anchorSequenceNumber.
• docHeaderId: number
  The unique identifier of the document header that's used to create a workflow task object.
• identificationKey: string
  The unique identifier of an instance associated with the workflow.
• task: string
  The task object in encoded format.
• taskNameSpace: string
  The task namespace of a workflow.
• taskSequence: string
  The task sequence object in encoded format.

{
    "type":"object",
    "properties":{
        "task":{
            "type":"string",
            "description":"The task object in encoded format.",
            "nullable":true
        },
        "docHeaderId":{
            "type":"number",
            "description":"The unique identifier of the document header that's used to create a workflow task object.",
            "nullable":true
        },
        "adhocApproverList":{
            "type":"array",
            "description":"A list of attributes to add approvers to the approval process. The list includes newAssigneeUsername, anchorUsername, anchorTypeCode, and anchorSequenceNumber.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "identificationKey":{
            "type":"string",
            "description":"The unique identifier of an instance associated with the workflow.",
            "nullable":true
        },
        "taskNameSpace":{
            "type":"string",
            "description":"The task namespace of a workflow.",
            "nullable":true
        },
        "taskSequence":{
            "type":"string",
            "description":"The task sequence object in encoded format.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : adhocApproverList

Type: array

A list of attributes to add approvers to the approval process. The list includes newAssigneeUsername, anchorUsername, anchorTypeCode, and anchorSequenceNumber.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"A list of attributes to add approvers to the approval process. The list includes newAssigneeUsername, anchorUsername, anchorTypeCode, and anchorSequenceNumber.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

• application/json
• application/vnd.oracle.adf.actionresult+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  The action returns a status message indicating whether new approvers are added to the approval sequence.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"The action returns a status message indicating whether new approvers are added to the approval sequence."
        }
    },
    "additionalProperties":false
}

Back to Top