Jump to

• Request
• Response

Process person and associated roles.

post

/fscmRestApi/resources/11.13.18.05/publicSectorPersonRoles

This action is used to process the person and the associated roles. The roles can be added or removed.

Request

Supported Media Types

• application/vnd.oracle.adf.action+json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorPersonRoles-perUserRoleActionRequest

Type: object

Show Source

• name(optional): string
  Allowed Values: [ "perUserRoleAction" ]

  This parameter value must be set to "perUserRoleAction".
• parameters(optional): array parameters
  Minimum Number of Items: 3

  Maximum Number of Items: 3

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "perUserRoleAction"
            ],
            "description":"This parameter value must be set to \"perUserRoleAction\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "userGuid":{
                            "type":"string",
                            "description":"The unique identifier of the person."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "roleGuid":{
                            "type":"string",
                            "description":"The unique identifier of the role."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "action":{
                            "type":"string",
                            "description":"Indicates if the role was added or removed."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":3,
            "maxItems":3,
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 3

Maximum Number of Items: 3

Show Source

• [0]: object parameters-items[0]
• [1]: object parameters-items[1]
• [2]: object parameters-items[2]

{
    "items":[
        {
            "properties":{
                "userGuid":{
                    "type":"string",
                    "description":"The unique identifier of the person."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "roleGuid":{
                    "type":"string",
                    "description":"The unique identifier of the role."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "action":{
                    "type":"string",
                    "description":"Indicates if the role was added or removed."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":3,
    "maxItems":3,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• userGuid(optional): string
  The unique identifier of the person.

{
    "properties":{
        "userGuid":{
            "type":"string",
            "description":"The unique identifier of the person."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[1]

Type: object

Show Source

• roleGuid(optional): string
  The unique identifier of the role.

{
    "properties":{
        "roleGuid":{
            "type":"string",
            "description":"The unique identifier of the role."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[2]

Type: object

Show Source

• action(optional): string
  Indicates if the role was added or removed.

{
    "properties":{
        "action":{
            "type":"string",
            "description":"Indicates if the role was added or removed."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.actionresult+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorPersonRoles-perUserRoleActionResponse

Type: object

Show Source

• return(optional): string
  Indicates if the role was processed.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"Indicates if the role was processed."
        }
    },
    "type":"object"
}

Back to Top