Jump to

• Request
• Response

Update the roles assigned to a subscriber

post

/hcmRestApi/resources/11.13.18.05/questionnaireSubscribers/{questionnaireSubscribersUniqID}/action/updateSubscriberRoleMaps

Updates the role assigned for a specific subscriber by replacing or modifying their assigned roles.

Request

Path Parameters

• questionnaireSubscribersUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Questionnaire Subscribers resource and used to uniquely identify an instance of Questionnaire Subscribers. The client should not generate the hash key value. Instead, the client should query on the Questionnaire Subscribers collection resource in order to navigate to a specific instance of Questionnaire Subscribers to get the hash key.

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

• subscriberRoleMaps: object subscriberRoleMaps
  Additional Properties Allowed: additionalProperties

  Input parameter for the custom action containing role details to update the role mappings.

{
    "type":"object",
    "properties":{
        "subscriberRoleMaps":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Input parameter for the custom action containing role details to update the role mappings.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : subscriberRoleMaps

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Input parameter for the custom action containing role details to update the role mappings.",
    "nullable":true
}

Input parameter for the custom action containing role details to update the role mappings.

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
  Return element that returns the list of roles assigned to a subscriber.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"array",
            "description":"Return element that returns the list of roles assigned to a subscriber.",
            "items":{
                "type":"string"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : result

Type: array

Return element that returns the list of roles assigned to a subscriber.

Show Source

• Array of: string

{
    "type":"array",
    "description":"Return element that returns the list of roles assigned to a subscriber.",
    "items":{
        "type":"string"
    }
}

Back to Top