Jump to

• Request
• Response

Create a set of role definitions

post

/fscmRestApi/resources/11.13.18.05/publicSectorRoleDefinitions

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorRoleDefinitions-item-response

Type: object

Show Source

• AbstractRole: string
  Title: Abstract Role

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 240

  The description of the role.
• DutyRole: string
  Read Only: true

  Maximum Length: 30

  Indicates if the role is of the type duty.
• ExternalId: string
  Read Only: true

  Maximum Length: 64

  The identifier of the external role.
• ExternalRole: string
  Read Only: true

  Maximum Length: 30

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

  Read Only: true

  Maximum Length: 30

  Indicates if the role is of the type job.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  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: string
  Title: Role Code

  Read Only: true

  Maximum Length: 240

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

  Read Only: true

  Maximum Length: 4000

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

  Read Only: true

  Maximum Length: 64

  The unique global identifier of the role.
• RoleId: integer (int64)
  Read Only: true

  The unique identifier of the role.
• RoleName: string
  Title: Role Name

  Read Only: true

  Maximum Length: 240

  The name for the role.

{
    "type":"object",
    "properties":{
        "Description":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RoleCommonName":{
            "title":"Role Code",
            "maxLength":"240",
            "type":"string",
            "description":"The unique identifier of the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalId":{
            "maxLength":"64",
            "type":"string",
            "description":"The identifier of the external role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DutyRole":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is of the type duty.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "type":"integer",
            "description":"The unique identifier of the role.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Status",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is available to be used in assignments.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleGuid":{
            "title":"Role Globally Unique ID",
            "maxLength":"64",
            "type":"string",
            "description":"The unique global identifier of the role.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExternalRole":{
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is of the type external.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobRole":{
            "title":"Job Role",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is of the type job.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleName":{
            "title":"Role Name",
            "maxLength":"240",
            "type":"string",
            "description":"The name for the role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "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.",
            "format":"int32",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "DelegationAllowed":{
            "title":"Delegation Allowed",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role can be assigned through delegation.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "=",
                    "<>"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AbstractRole":{
            "title":"Abstract Role",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is of the type abstract.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataRole":{
            "title":"Data Role",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates if the role is of the type role.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleDistinguishedName":{
            "title":"Role Distinguished Name",
            "maxLength":"4000",
            "type":"string",
            "description":"The distinguished name defined within the LDAP. It contains the relevant group information to provide a unique name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top