Jump to

• Request
• Response

Submit for deletion

post

/fscmRestApi/resources/11.13.18.05/deleteGroups/action/submitForDelete

This custom action will submit the entities in a delete group for deletion.

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

• deleteGroupName: string
  Submit entities in the specified delete group for deletion.

{
    "type":"object",
    "properties":{
        "deleteGroupName":{
            "type":"string",
            "description":"Submit entities in the specified delete group for deletion.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

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
  This attribute holds the message returned when the submit for delete action is triggered for a delete group. The message type will always be Success, except for these scenarios: the delete group has no entities added or the delete group has more than 20,000 entities, or a check constraint process is already running on the delete group.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"This attribute holds the message returned when the submit for delete action is triggered for a delete group. The message type will always be Success, except for these scenarios: the delete group has no entities added or the delete group has more than 20,000 entities, or a check constraint process is already running on the delete group."
        }
    },
    "additionalProperties":false
}

Back to Top