Jump to

• Request
• Response
• Examples

Cancel all transfer authorization groups

post

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/action/cancelTransferAuthorizationGrps

Transfer Authorizations can be canceled until the transfer authorization along with the transactions and accounting aren't approved. Once they're approved, a transfer authorization can't be canceled. All transfer authorizations in a group must be canceled together.

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

• transferAuthGroupIdList: array transferAuthGroupIdList
  List of transfer authorization group identifiers.
• transferAuthGroupNumList: array transferAuthGroupNumList
  List of transfer authorization group numbers.

{
    "type":"object",
    "properties":{
        "transferAuthGroupIdList":{
            "type":"array",
            "description":"List of transfer authorization group identifiers.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "transferAuthGroupNumList":{
            "type":"array",
            "description":"List of transfer authorization group numbers.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : transferAuthGroupIdList

Type: array

List of transfer authorization group identifiers.

Show Source

• Array of: number

{
    "type":"array",
    "description":"List of transfer authorization group identifiers.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : transferAuthGroupNumList

Type: array

List of transfer authorization group numbers.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of transfer authorization group numbers.",
    "nullable":true,
    "items":{
        "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): array result
  The action returns a cancellation message for each transfer authorization group if the action completes successfully. If there is a validation failure, a validation exception is returned in the response.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"The action returns a cancellation message for each transfer authorization group if the action completes successfully. If there is a validation failure, a validation exception is returned in the response.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

The action returns a cancellation message for each transfer authorization group if the action completes successfully. If there is a validation failure, a validation exception is returned in the response.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The action returns a cancellation message for each transfer authorization group if the action completes successfully. If there is a validation failure, a validation exception is returned in the response.",
    "items":{
        "type":"string"
    }
}

Back to Top

Examples

The following example shows how to cancel all transfer authorization groups using POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.action+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/action/cancelTransferAuthorizationGrps

Example Request Payload

The following example shows the contents of the request body in JSON format:

{
    "transferAuthGroupNumList": ["REV-Fund Transfer-Feb01-02-num-01"],
    "transferAuthGroupIdList": []
}

Example of Response Body

The following example shows the contents of the response body in JSON format:

{
    "result": [
        "REV-Fund Transfer-Feb01-02-num-01 : Transfer Authorization Group cancelled successfully"
    ]
}

Back to Top