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

CreateCollaborationChangeRequest

Creates a new change request to modify an existing collaboration. This enables post-creation modifications to collaborations through a structured API-driven approach.

Request Syntax


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

{
   "changes": [ 
      { 
         "specification": { ... },
         "specificationType": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

collaborationIdentifier

The identifier of the collaboration that the change request is made against.

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.

changes

The list of changes to apply to the collaboration. Each change specifies the type of modification and the details of what should be changed.

Type: Array of ChangeInput objects

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "collaborationChangeRequest": { 
      "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

ServiceQuotaExceededException

Request denied because service quota has been exceeded.

quotaName: The name of the quota.
quotaValue: The value of the quota.

HTTP Status Code: 402

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