Jump to

• Request
• Response
• Examples

Approve all transactions in the transfer authorization

post

/fscmRestApi/resources/11.13.18.05/intercompanyAgreements/action/approveTransferAuthorizations

When approval is initiated, all transactions in the transfer authorization will be approved.

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

• transferAuthIdList: array transferAuthIdList
  List of transfer authorization identifiers.
• transferAuthNumList: array transferAuthNumList
  List of transfer authorization numbers.

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

Nested Schema : transferAuthIdList

Type: array

List of transfer authorization identifiers.

Show Source

• Array of: number

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

Nested Schema : transferAuthNumList

Type: array

List of transfer authorization numbers.

Show Source

• Array of: string

{
    "type":"array",
    "description":"List of transfer authorization 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 confirmation message for each transfer authorization 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 confirmation message for each transfer authorization 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 confirmation message for each transfer authorization 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 confirmation message for each transfer authorization 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 approve all transactions in the transfer authorization using POST request on the REST resource using cURL. When approval is initiated, all transactions in the transfer authorization will be approved.

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/approveTransferAuthorizations

Example Request Payload

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

{
    "transferAuthNumList": ["Fund Transfer-Feb01-02-num-01"]
}

Example of Response Body

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

{
    "result": [
        "Fund Transfer-Feb01-02-num-01 : transfer authorization is approved successfully"
    ]
}

Back to Top