Jump to

• Request
• Response

Create bulk removal of tags from person objects

post

/fscmRestApi/resources/11.13.18.05/hedPersonTags/action/bulkRemoveTags

Creates bulk removal of tags from the specified person objects. Clients can either provide the specific person identifier values, or provide the search criteria to look for matching person objects.

Request

Header Parameters

• Metadata-Context: string
  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: string
  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

• ObjectIds: array ObjectIds
  The list of tag codes to be removed from the matching person objects.
• QueryCriteria: array QueryCriteria
  The list of tag codes to be removed from the matching person objects.
• QueryKeyword: string
  The list of tag codes to be removed from the matching person objects.
• RunDateTime: string (date-time)
  The list of tag codes to be removed from the matching person objects.
• TagCodes: array TagCodes
  The list of tag codes to be removed from the matching person objects.

{
    "type":"object",
    "properties":{
        "ObjectIds":{
            "type":"array",
            "description":"The list of tag codes to be removed from the matching person objects.",
            "nullable":true,
            "items":{
                "type":"number"
            }
        },
        "QueryCriteria":{
            "type":"array",
            "description":"The list of tag codes to be removed from the matching person objects.",
            "nullable":true,
            "items":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            }
        },
        "RunDateTime":{
            "type":"string",
            "description":"The list of tag codes to be removed from the matching person objects.",
            "format":"date-time",
            "nullable":true
        },
        "TagCodes":{
            "type":"array",
            "description":"The list of tag codes to be removed from the matching person objects.",
            "nullable":true,
            "items":{
                "type":"string"
            }
        },
        "QueryKeyword":{
            "type":"string",
            "description":"The list of tag codes to be removed from the matching person objects.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : ObjectIds

Type: array

The list of tag codes to be removed from the matching person objects.

Show Source

• Array of: number

{
    "type":"array",
    "description":"The list of tag codes to be removed from the matching person objects.",
    "nullable":true,
    "items":{
        "type":"number"
    }
}

Nested Schema : QueryCriteria

Type: array

The list of tag codes to be removed from the matching person objects.

Show Source

• Array of: object items
  Additional Properties Allowed: additionalProperties

{
    "type":"array",
    "description":"The list of tag codes to be removed from the matching person objects.",
    "nullable":true,
    "items":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    }
}

Nested Schema : TagCodes

Type: array

The list of tag codes to be removed from the matching person objects.

Show Source

• Array of: string

{
    "type":"array",
    "description":"The list of tag codes to be removed from the matching person objects.",
    "nullable":true,
    "items":{
        "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): object result
  Additional Properties Allowed: additionalProperties

  The list of tag codes to be removed from the matching person objects.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"object",
            "additionalProperties":{
                "type":"number"
            },
            "description":"The list of tag codes to be removed from the matching person objects."
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: object

Additional Properties Allowed

Show Source

• number

{
    "type":"object",
    "additionalProperties":{
        "type":"number"
    },
    "description":"The list of tag codes to be removed from the matching person objects."
}

The list of tag codes to be removed from the matching person objects.

Back to Top