Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateCollaborationChangeRequest

Updates an existing collaboration change request. This operation allows approval actions for pending change requests in collaborations (APPROVE, DENY, CANCEL, COMMIT).

For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.

Request Syntax


PATCH /collaborations/collaborationIdentifier/changeRequests/changeRequestIdentifier HTTP/1.1
Content-type: application/json

{
   "action": "string"
}

URI Request Parameters

The request uses the following URI parameters.

changeRequestIdentifier

The unique identifier of the specific change request to be updated within the collaboration.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

collaborationIdentifier

The unique identifier of the collaboration that contains the change request to be updated.

Length Constraints: Fixed length of 36.

Pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

Required: Yes

Request Body

The request accepts the following data in JSON format.

action

The action to perform on the change request. Valid values include APPROVE (approve the change), DENY (reject the change), CANCEL (cancel the request), and COMMIT (commit after the request is approved).

For change requests without automatic approval, a member in the collaboration can manually APPROVE or DENY a change request. The collaboration owner can manually CANCEL or COMMIT a change request.

Type: String

Valid Values: APPROVE | DENY | CANCEL | COMMIT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "collaborationChangeRequest": { 
      "approvals": { 
         "string" : { 
            "status": "string"
         }
      },
      "changes": [ 
         { 
            "specification": { ... },
            "specificationType": "string",
            "types": [ "string" ]
         }
      ],
      "collaborationId": "string",
      "createTime": number,
      "id": "string",
      "isAutoApproved": boolean,
      "status": "string",
      "updateTime": number
   }
}

Response Elements

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

The following data is returned in JSON format by the service.

collaborationChangeRequest

Represents a request to modify a collaboration. Change requests enable structured modifications to collaborations after they have been created.

Type: CollaborationChangeRequest object

Errors

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

AccessDeniedException

Caller does not have sufficient access to perform this action.

reason: A reason code for the exception.

HTTP Status Code: 403

ConflictException

Updating or deleting a resource can cause an inconsistent state.

reason: A reason code for the exception.
resourceId: The ID of the conflicting resource.
resourceType: The type of the conflicting resource.

HTTP Status Code: 409

InternalServerException

Unexpected error during processing of request.

HTTP Status Code: 500

ResourceNotFoundException

Request references a resource which does not exist.

resourceId: The Id of the missing resource.
resourceType: The type of the missing resource.

HTTP Status Code: 404

ThrottlingException

Request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the specified constraints.

fieldList: Validation errors for specific input parameters.
reason: A reason code for the exception.

HTTP Status Code: 400