Jump to

• Request
• Response

Create Role

post

/role

Send a request to this endpoint to create one or more Role. An application object will be created for each JSON object provided in the request body.

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of Role objects.

Root Schema : List<Role>

Type: array

Title: List<Role>

Show Source

• Array of: object Role
  Title: Role

  Role Entity

{
    "title":"List<Role>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Role"
    }
}

Nested Schema : Role

Type: object

Title: Role

Role Entity

Show Source

• CalculateCostFromUnits: boolean
  The option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated.
• CreateDate: string (date-time)
  The date this role was created.
• CreateUser: string
  The name of the user that created this role.
• Id: string
  The short code that uniquely identifies the role.
• LastUpdateDate: string (date-time)
  The date this role was last updated.
• LastUpdateUser: string
  The name of the user that last updated this role.
• Name: string
  The name of the role. The role name uniquely identifies the role.
• ObjectId: integer (int32)
  The unique ID generated by the system.
• ParentObjectId: integer (int32)
  The unique ID of the parent role of this role in the hierarchy.
• Responsibilities: string
  The responsibilities for the role.
• SequenceNumber: integer (int32)
  The sequence number for sorting.

{
    "title":"Role",
    "type":"object",
    "properties":{
        "CalculateCostFromUnits":{
            "type":"boolean",
            "description":"The option that indicates whether costs and quantities are linked, and whether quantities should be updated when costs are updated."
        },
        "CreateDate":{
            "type":"string",
            "description":"The date this role was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this role."
        },
        "Id":{
            "type":"string",
            "description":"The short code that uniquely identifies the role."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this role was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this role."
        },
        "Name":{
            "type":"string",
            "description":"The name of the role. The role name uniquely identifies the role."
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique ID generated by the system.",
            "format":"int32"
        },
        "ParentObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent role of this role in the hierarchy.",
            "format":"int32"
        },
        "Responsibilities":{
            "type":"string",
            "description":"The responsibilities for the role."
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number for sorting.",
            "format":"int32"
        }
    },
    "description":"Role Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

Resource Created.

Body ()

Root Schema : String

Type: string

Title: String

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top