Jump to

• Request
• Response

Update a role definition

patch

/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions/{publicSectorRoleDefinitionsUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorRoleDefinitionsUniqID: string
  Identifier to Role Definitions

Body ()

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

Root Schema : publicSectorRoleDefinitions-item

Type: object

Show Source

• AbstractRole(optional): string
  Title: Abstract Role

  Maximum Length: 30

  Indicates if the role is of the type abstract.
• ActiveFlag(optional): string
  Title: Status

  Maximum Length: 30

  Indicates if the role is available to be used in assignments.
• DataRole(optional): string
  Title: Data Role

  Maximum Length: 30

  Indicates if the role is of the type role.
• DelegationAllowed(optional): string
  Title: Delegation Allowed

  Maximum Length: 30

  Indicates if the role can be assigned through delegation.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the role.
• DutyRole(optional): string
  Maximum Length: 30

  Indicates if the role is of the type duty.
• ExternalId(optional): string
  Maximum Length: 64

  The identifier of the external role.
• ExternalRole(optional): string
  Maximum Length: 30

  Indicates if the role is of the type external.
• JobRole(optional): string
  Title: Job Role

  Maximum Length: 30

  Indicates if the role is of the type job.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The identifier of the optimistic lock. The value is incremented each time the row is updated. The values at the beginning and at the end of the transaction are compared to determine if a session updated the row since it was queried.
• RoleCommonName(optional): string
  Title: Role Code

  Maximum Length: 240

  The unique identifier of the role.
• RoleDistinguishedName(optional): string
  Title: Role Distinguished Name

  Maximum Length: 4000

  The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name.
• RoleGuid(optional): string
  Title: Role Globally Unique ID

  Maximum Length: 64

  The unique global identifier of the role.
• RoleId(optional): integer(int64)
  The unique identifier of the role.
• RoleName(optional): string
  Title: Role Name

  Maximum Length: 240

  The name for the role.

{
    "properties":{
        "AbstractRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type abstract.",
            "title":"Abstract Role"
        },
        "ActiveFlag":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is available to be used in assignments.",
            "title":"Status"
        },
        "DataRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type role.",
            "title":"Data Role"
        },
        "DelegationAllowed":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role can be assigned through delegation.",
            "title":"Delegation Allowed"
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the role.",
            "title":"Description"
        },
        "DutyRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type duty."
        },
        "ExternalId":{
            "maxLength":64,
            "type":"string",
            "description":"The identifier of the external role."
        },
        "ExternalRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type external."
        },
        "JobRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type job.",
            "title":"Job Role"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the optimistic lock. The value is incremented each time the row is updated. The values at the beginning and at the end of the transaction are compared to determine if a session updated the row since it was queried."
        },
        "RoleCommonName":{
            "maxLength":240,
            "type":"string",
            "description":"The unique identifier of the role.",
            "title":"Role Code"
        },
        "RoleDistinguishedName":{
            "maxLength":4000,
            "type":"string",
            "description":"The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name.",
            "title":"Role Distinguished Name"
        },
        "RoleGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique global identifier of the role.",
            "title":"Role Globally Unique ID"
        },
        "RoleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the role."
        },
        "RoleName":{
            "maxLength":240,
            "type":"string",
            "description":"The name for the role.",
            "title":"Role Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorRoleDefinitions-item

Type: object

Show Source

• AbstractRole(optional): string
  Title: Abstract Role

  Maximum Length: 30

  Indicates if the role is of the type abstract.
• ActiveFlag(optional): string
  Title: Status

  Maximum Length: 30

  Indicates if the role is available to be used in assignments.
• DataRole(optional): string
  Title: Data Role

  Maximum Length: 30

  Indicates if the role is of the type role.
• DelegationAllowed(optional): string
  Title: Delegation Allowed

  Maximum Length: 30

  Indicates if the role can be assigned through delegation.
• Description(optional): string
  Title: Description

  Maximum Length: 240

  The description of the role.
• DutyRole(optional): string
  Maximum Length: 30

  Indicates if the role is of the type duty.
• ExternalId(optional): string
  Maximum Length: 64

  The identifier of the external role.
• ExternalRole(optional): string
  Maximum Length: 30

  Indicates if the role is of the type external.
• JobRole(optional): string
  Title: Job Role

  Maximum Length: 30

  Indicates if the role is of the type job.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The identifier of the optimistic lock. The value is incremented each time the row is updated. The values at the beginning and at the end of the transaction are compared to determine if a session updated the row since it was queried.
• RoleCommonName(optional): string
  Title: Role Code

  Maximum Length: 240

  The unique identifier of the role.
• RoleDistinguishedName(optional): string
  Title: Role Distinguished Name

  Maximum Length: 4000

  The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name.
• RoleGuid(optional): string
  Title: Role Globally Unique ID

  Maximum Length: 64

  The unique global identifier of the role.
• RoleId(optional): integer(int64)
  The unique identifier of the role.
• RoleName(optional): string
  Title: Role Name

  Maximum Length: 240

  The name for the role.

{
    "properties":{
        "AbstractRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type abstract.",
            "title":"Abstract Role"
        },
        "ActiveFlag":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is available to be used in assignments.",
            "title":"Status"
        },
        "DataRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type role.",
            "title":"Data Role"
        },
        "DelegationAllowed":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role can be assigned through delegation.",
            "title":"Delegation Allowed"
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"The description of the role.",
            "title":"Description"
        },
        "DutyRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type duty."
        },
        "ExternalId":{
            "maxLength":64,
            "type":"string",
            "description":"The identifier of the external role."
        },
        "ExternalRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type external."
        },
        "JobRole":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates if the role is of the type job.",
            "title":"Job Role"
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The identifier of the optimistic lock. The value is incremented each time the row is updated. The values at the beginning and at the end of the transaction are compared to determine if a session updated the row since it was queried."
        },
        "RoleCommonName":{
            "maxLength":240,
            "type":"string",
            "description":"The unique identifier of the role.",
            "title":"Role Code"
        },
        "RoleDistinguishedName":{
            "maxLength":4000,
            "type":"string",
            "description":"The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name.",
            "title":"Role Distinguished Name"
        },
        "RoleGuid":{
            "maxLength":64,
            "type":"string",
            "description":"The unique global identifier of the role.",
            "title":"Role Globally Unique ID"
        },
        "RoleId":{
            "format":"int64",
            "type":"integer",
            "description":"The unique identifier of the role."
        },
        "RoleName":{
            "maxLength":240,
            "type":"string",
            "description":"The name for the role.",
            "title":"Role Name"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top