Skip to main content

PUT Role

Overview


The following table contains important information about the PUT method in regards to updating a role.

PUT Role
MethodPUT
URL or Endpoint/api/projects/projectId/roles
HeadersAuthorization
ParametersprojectId
Bodyid, name, description, isActive, organizationId

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

{
"id": 1036,
"name": "Tester updated",
"description": "updated tester role",
"isActive": true,
"organizationId": null
}

Information about the fields that appear in the request body are displayed in the table below.

Field NameTypeDescription
idinteger($int32)The id of the role.
namestringThe name of the role.
descriptionstringThe description of the role.
isActiveboolIndicates whether the role is active.
organizationIdinteger($int32)The id of the organization.

Response

{
"success": true,
"errors": [],
"messages": [
"Role updated successfully!"
],
"result": {
"id": 1036,
"name": "Tester updated",
"description": "updated tester role",
"isActive": true,
"organizationId": null
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the role.
namestringThe name of the role.
descriptionstringThe description of the role.
isActiveboolIndicates whether the role is active.
organizationIdinteger($int32)The id of the organization.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed