Jump to

• Request
• Response

v1.0

put

/ec-site-svc/rest/v1.0/entitymanagement/entities/{entityType}/{srcEntityId}/manage

Manages a specific contact or organization association for the source entity. Allowed action values: RETIRE or TRANSFER.

Request

Path Parameters

• entityType(required): string
  Entity type. Allowed values: INVESTIGATOR, INSTITUTION, LAB, DEPOT.

  Example:

  INVESTIGATOR

• srcEntityId(required): string
  Contact or Organization ID, entity can be either of Investigator, Institution, Lab or Depot.

  Example:

  C36A3197FDEE433FB5547EE83DE99E4B

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : ENTITY_MANAGEMENT_REQUEST_TITLE

Type: object

Title: ENTITY_MANAGEMENT_REQUEST_TITLE

ENTITY_MANAGEMENT_REQUEST_DESC

Show Source

• entityManagementRequest(required): object MANAGE_STUDY_ENTITY_DTO_TITLE
  Title: MANAGE_STUDY_ENTITY_DTO_TITLE

  MANAGE_STUDY_ENTITY_DTO_DESC

{
    "title":"ENTITY_MANAGEMENT_REQUEST_TITLE",
    "required":[
        "entityManagementRequest"
    ],
    "type":"object",
    "properties":{
        "entityManagementRequest":{
            "title":"MANAGE_STUDY_ENTITY_DTO_TITLE",
            "required":[
                "studyId"
            ],
            "type":"object",
            "properties":{
                "studyId":{
                    "title":"MANAGE_STUDY_ENTITY_DTO_STUDY_ID_TITLE",
                    "type":"string",
                    "description":"MANAGE_STUDY_ENTITY_DTO_STUDY_ID_DESC",
                    "format":"uuid"
                },
                "studyEntities":{
                    "title":"MANAGE_ENTITY_DTO_TITLE",
                    "required":[
                        "entityAction",
                        "entityType"
                    ],
                    "type":"object",
                    "properties":{
                        "reason":{
                            "title":"Reason",
                            "maxLength":255,
                            "minLength":0,
                            "type":"string",
                            "description":"Reason provided for the audited update.",
                            "example":"Protocol update requested by study operations."
                        },
                        "comment":{
                            "title":"Comment",
                            "maxLength":2048,
                            "minLength":0,
                            "type":"string",
                            "description":"Additional comment captured for the audited update.",
                            "example":"Association adjusted after data reconciliation."
                        },
                        "entityId":{
                            "title":"MANAGE_ENTITY_DTO_ENTITY_ID_TITLE",
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_ENTITY_ID_DESC",
                            "format":"uuid"
                        },
                        "entityName":{
                            "title":"MANAGE_ENTITY_DTO_ENTITY_NAME_TITLE",
                            "maxLength":50,
                            "minLength":0,
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_ENTITY_NAME_DESC",
                            "example":"Acme Institution"
                        },
                        "entityType":{
                            "title":"MANAGE_ENTITY_DTO_ENTITY_TYPE_TITLE",
                            "maxLength":25,
                            "minLength":0,
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_ENTITY_TYPE_DESC",
                            "example":"INVESTIGATOR"
                        },
                        "entityAction":{
                            "title":"MANAGE_ENTITY_DTO_ENTITY_ACTION_TITLE",
                            "maxLength":25,
                            "minLength":0,
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_ENTITY_ACTION_DESC",
                            "example":"TRANSFER"
                        },
                        "targetTenantEntityId":{
                            "title":"MANAGE_ENTITY_DTO_TARGET_ID_TITLE",
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_TARGET_ID_DESC",
                            "format":"uuid"
                        },
                        "modes":{
                            "title":"MANAGE_ENTITY_DTO_MODES_TITLE",
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_MODES_DESC",
                            "enum":[
                                "TESTING",
                                "PRODUCTION",
                                "TRAINING",
                                "STUDY_DESIGN"
                            ]
                        },
                        "associationId":{
                            "title":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_TITLE",
                            "type":"string",
                            "description":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_DESC",
                            "format":"uuid"
                        }
                    },
                    "description":"MANAGE_ENTITY_DTO_DESC"
                }
            },
            "description":"MANAGE_STUDY_ENTITY_DTO_DESC",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ]
        }
    },
    "description":"ENTITY_MANAGEMENT_REQUEST_DESC"
}

Nested Schema : MANAGE_STUDY_ENTITY_DTO_TITLE

Type: object

Title: MANAGE_STUDY_ENTITY_DTO_TITLE

MANAGE_STUDY_ENTITY_DTO_DESC

Show Source

• studyEntities: object MANAGE_ENTITY_DTO_TITLE
  Title: MANAGE_ENTITY_DTO_TITLE

  MANAGE_ENTITY_DTO_DESC
• studyId(required): string (uuid)
  Title: MANAGE_STUDY_ENTITY_DTO_STUDY_ID_TITLE

  MANAGE_STUDY_ENTITY_DTO_STUDY_ID_DESC

{
    "title":"MANAGE_STUDY_ENTITY_DTO_TITLE",
    "required":[
        "studyId"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "title":"MANAGE_STUDY_ENTITY_DTO_STUDY_ID_TITLE",
            "type":"string",
            "description":"MANAGE_STUDY_ENTITY_DTO_STUDY_ID_DESC",
            "format":"uuid"
        },
        "studyEntities":{
            "title":"MANAGE_ENTITY_DTO_TITLE",
            "required":[
                "entityAction",
                "entityType"
            ],
            "type":"object",
            "properties":{
                "reason":{
                    "title":"Reason",
                    "maxLength":255,
                    "minLength":0,
                    "type":"string",
                    "description":"Reason provided for the audited update.",
                    "example":"Protocol update requested by study operations."
                },
                "comment":{
                    "title":"Comment",
                    "maxLength":2048,
                    "minLength":0,
                    "type":"string",
                    "description":"Additional comment captured for the audited update.",
                    "example":"Association adjusted after data reconciliation."
                },
                "entityId":{
                    "title":"MANAGE_ENTITY_DTO_ENTITY_ID_TITLE",
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_ENTITY_ID_DESC",
                    "format":"uuid"
                },
                "entityName":{
                    "title":"MANAGE_ENTITY_DTO_ENTITY_NAME_TITLE",
                    "maxLength":50,
                    "minLength":0,
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_ENTITY_NAME_DESC",
                    "example":"Acme Institution"
                },
                "entityType":{
                    "title":"MANAGE_ENTITY_DTO_ENTITY_TYPE_TITLE",
                    "maxLength":25,
                    "minLength":0,
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_ENTITY_TYPE_DESC",
                    "example":"INVESTIGATOR"
                },
                "entityAction":{
                    "title":"MANAGE_ENTITY_DTO_ENTITY_ACTION_TITLE",
                    "maxLength":25,
                    "minLength":0,
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_ENTITY_ACTION_DESC",
                    "example":"TRANSFER"
                },
                "targetTenantEntityId":{
                    "title":"MANAGE_ENTITY_DTO_TARGET_ID_TITLE",
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_TARGET_ID_DESC",
                    "format":"uuid"
                },
                "modes":{
                    "title":"MANAGE_ENTITY_DTO_MODES_TITLE",
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_MODES_DESC",
                    "enum":[
                        "TESTING",
                        "PRODUCTION",
                        "TRAINING",
                        "STUDY_DESIGN"
                    ]
                },
                "associationId":{
                    "title":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_TITLE",
                    "type":"string",
                    "description":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_DESC",
                    "format":"uuid"
                }
            },
            "description":"MANAGE_ENTITY_DTO_DESC"
        }
    },
    "description":"MANAGE_STUDY_ENTITY_DTO_DESC",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Nested Schema : MANAGE_ENTITY_DTO_TITLE

Type: object

Title: MANAGE_ENTITY_DTO_TITLE

MANAGE_ENTITY_DTO_DESC

Show Source

• associationId: string (uuid)
  Title: MANAGE_ENTITY_DTO_ASSOCIATION_ID_TITLE

  MANAGE_ENTITY_DTO_ASSOCIATION_ID_DESC
• comment: string
  Title: Comment

  Minimum Length: 0

  Maximum Length: 2048

  Additional comment captured for the audited update.

  Example: Association adjusted after data reconciliation.
• entityAction(required): string
  Title: MANAGE_ENTITY_DTO_ENTITY_ACTION_TITLE

  Minimum Length: 0

  Maximum Length: 25

  MANAGE_ENTITY_DTO_ENTITY_ACTION_DESC

  Example: TRANSFER
• entityId: string (uuid)
  Title: MANAGE_ENTITY_DTO_ENTITY_ID_TITLE

  MANAGE_ENTITY_DTO_ENTITY_ID_DESC
• entityName: string
  Title: MANAGE_ENTITY_DTO_ENTITY_NAME_TITLE

  Minimum Length: 0

  Maximum Length: 50

  MANAGE_ENTITY_DTO_ENTITY_NAME_DESC

  Example: Acme Institution
• entityType(required): string
  Title: MANAGE_ENTITY_DTO_ENTITY_TYPE_TITLE

  Minimum Length: 0

  Maximum Length: 25

  MANAGE_ENTITY_DTO_ENTITY_TYPE_DESC

  Example: INVESTIGATOR
• modes: string
  Title: MANAGE_ENTITY_DTO_MODES_TITLE

  Allowed Values: [ "TESTING", "PRODUCTION", "TRAINING", "STUDY_DESIGN" ]

  MANAGE_ENTITY_DTO_MODES_DESC
• reason: string
  Title: Reason

  Minimum Length: 0

  Maximum Length: 255

  Reason provided for the audited update.

  Example: Protocol update requested by study operations.
• targetTenantEntityId: string (uuid)
  Title: MANAGE_ENTITY_DTO_TARGET_ID_TITLE

  MANAGE_ENTITY_DTO_TARGET_ID_DESC

{
    "title":"MANAGE_ENTITY_DTO_TITLE",
    "required":[
        "entityAction",
        "entityType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "title":"Reason",
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason provided for the audited update.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "entityId":{
            "title":"MANAGE_ENTITY_DTO_ENTITY_ID_TITLE",
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_ENTITY_ID_DESC",
            "format":"uuid"
        },
        "entityName":{
            "title":"MANAGE_ENTITY_DTO_ENTITY_NAME_TITLE",
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_ENTITY_NAME_DESC",
            "example":"Acme Institution"
        },
        "entityType":{
            "title":"MANAGE_ENTITY_DTO_ENTITY_TYPE_TITLE",
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_ENTITY_TYPE_DESC",
            "example":"INVESTIGATOR"
        },
        "entityAction":{
            "title":"MANAGE_ENTITY_DTO_ENTITY_ACTION_TITLE",
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_ENTITY_ACTION_DESC",
            "example":"TRANSFER"
        },
        "targetTenantEntityId":{
            "title":"MANAGE_ENTITY_DTO_TARGET_ID_TITLE",
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_TARGET_ID_DESC",
            "format":"uuid"
        },
        "modes":{
            "title":"MANAGE_ENTITY_DTO_MODES_TITLE",
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_MODES_DESC",
            "enum":[
                "TESTING",
                "PRODUCTION",
                "TRAINING",
                "STUDY_DESIGN"
            ]
        },
        "associationId":{
            "title":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_TITLE",
            "type":"string",
            "description":"MANAGE_ENTITY_DTO_ASSOCIATION_ID_DESC",
            "format":"uuid"
        }
    },
    "description":"MANAGE_ENTITY_DTO_DESC"
}

Examples

Select an example Manage Study Entities Request

Back to Top

Response

Supported Media Types

• application/json

204 Response

Successful operation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example No Content Success Response

400 Response

Returned when one or more path parameters, query parameters, or request-body values fail endpoint validation.

Body ()

Root Schema : SDFResponse

Type: object

Title: SDFResponse

Wrapper for service responses containing result or error data.

Show Source

• errorData: object ErrorResponseData
• result: object result
  The result object for successful requests. Type depends on the API operation.
• status: string
  Status of the response, either 'success' or an error indication.

  Example: success

{
    "title":"SDFResponse",
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of the response, either 'success' or an error indication.",
            "example":"success"
        },
        "result":{
            "type":"object",
            "description":"The result object for successful requests. Type depends on the API operation.",
            "example":{
                "hasMore":"true",
                "totalResults":5,
                "count":5,
                "data":[
                ]
            }
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    },
    "description":"Wrapper for service responses containing result or error data."
}

Nested Schema : ErrorResponseData

Type: object

Show Source

• details: object details
• errorCode: string
• errorMessage: string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string"
        },
        "errorMessage":{
            "type":"string"
        },
        "details":{
            "type":"object"
        }
    }
}

Nested Schema : result

Type: object

The result object for successful requests. Type depends on the API operation.

Example:

{
    "hasMore":"true",
    "totalResults":5,
    "count":5,
    "data":[
    ]
}

Nested Schema : details

Type: object

Examples

Select an example Bad Request Response

Back to Top