Jump to

• Request
• Response

Update a Resource Role Assignment

put

/api/restapi/resourceRoleAssignment

Send a request to this endpoint to update a resource role assignment.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ApiEntityResourceRoleAssignmentInput

Type: object

Title: ApiEntityResourceRoleAssignmentInput

This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.

• resourceRoleAssignmentId
• resourceId,roleId
• resourceCode,workspaceCode,roleId
• resourceId,workspaceCode,roleCode
• resourceCode,workspaceCode,roleCode

Show Source

• link: string (url)
  Read Only: true

  Deprecated. As of 23.10.
  The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
• primaryFlag: boolean
  Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.
• proficiency: string
  Allowed Values: [ "ONE", "TWO", "THREE", "FOUR", "FIVE" ]

  The skill level of the resource.
  Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.
• projectCode: string
  Maximum Length: 60

  The unique identifier for a project set by the user who created the project.
• projectId: integer (int64)
  The unique identifier for the project.
• resourceCode: string
  Minimum Length: 1

  Maximum Length: 60

  The unique identifier for the resource or role.
• resourceId(required): integer (int64)
  The unique identifier for the resource.The resource object can also be identified by its unique criteria.
• resourceRoleAssignmentId: integer (int64)
  The system-generated identifier of the resource role assignment.
• roleCode: string
  Minimum Length: 1

  Maximum Length: 60

  The user-specified identifier of the role.
• roleId(required): integer (int64)
  The unique identifier for the role.The role object can also be identified by its unique criteria.
• updateDate: string (date-time)
  Read Only: true

  Deprecated. As of 23.10.
  Date when the record was last updated.
• workspaceCode: string
  Minimum Length: 0

  Maximum Length: 60

  The user-specified identifier of a workspace.

{
    "title":"ApiEntityResourceRoleAssignmentInput",
    "required":[
        "resourceId",
        "roleId"
    ],
    "type":"object",
    "properties":{
        "link":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>The self-link to the object. This field is populated only in the responses generated by the <i>batch create</i> APIs.",
            "format":"url",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "projectId":{
            "type":"integer",
            "description":"The unique identifier for the project.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "projectCode":{
            "maxLength":"60",
            "type":"string",
            "description":"The unique identifier for a project set by the user who created the project.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "workspaceCode":{
            "maxLength":"60",
            "minLength":"0",
            "type":"string",
            "description":"The user-specified identifier of a workspace.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceId":{
            "type":"integer",
            "description":"The unique identifier for the resource.The resource object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "proficiency":{
            "type":"string",
            "description":"The skill level of the resource. <br />Skill levels are Master, Expert, Skilled, Proficient, and Inexperienced.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ],
            "enum":[
                "ONE",
                "TWO",
                "THREE",
                "FOUR",
                "FIVE"
            ]
        },
        "resourceCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The unique identifier for the resource or role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "roleId":{
            "type":"integer",
            "description":"The unique identifier for the role.The role object can also be identified by its unique criteria.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "roleCode":{
            "maxLength":"60",
            "minLength":"1",
            "type":"string",
            "description":"The user-specified identifier of the role.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "resourceRoleAssignmentId":{
            "type":"integer",
            "description":"The system-generated identifier of the resource role assignment.",
            "format":"int64",
            "exampleSetFlag":false,
            "types":[
                "integer"
            ]
        },
        "primaryFlag":{
            "type":"boolean",
            "description":"Determines whether this is the resource's main role. A role that does not have this option selected indicates that this is a secondary role for the resource. You can only assign one primary role per resource. A resource is not required to have a primary role.",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "updateDate":{
            "type":"string",
            "description":"<b>Deprecated.</b> As of <i>23.10</i>.</br>Date when the record was last updated.",
            "format":"date-time",
            "readOnly":true,
            "deprecated":true,
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"This entity represents a ResourceRoleAssignment object, a unique ResourceRoleAssignment object can be identified by the following combinations of the fields.<ul><li>resourceRoleAssignmentId</li><li>resourceId,roleId</li><li>resourceCode,workspaceCode,roleId</li><li>resourceId,workspaceCode,roleCode</li><li>resourceCode,workspaceCode,roleCode</li>",
    "exampleSetFlag":false
}

Examples

Select an example Update a Resource Role Assignment Using Resource Role Assignment ID.

Back to Top

Response

204 Response

Successful operation with no content.

400 Response

Invalid input for the Resource Role Assignment service.

Back to Top