REST API for Clinical One Platform

Manage a given study entity associated with a contact or organization

put

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

Manages a specific contact or organization associations, allowed transition states are RETIRE or TRANSFER.

Request

Path Parameters

entityType(required): string

Contact or Organization type, allowed types are Investigator, Institution, Lab or Depot.
srcEntityId(required): string

Contact or Organization ID, entity can be either of Investigator, Institution, Lab or Depot.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

entityManagementRequest(required): array entityManagementRequest

{
    "required":[
        "entityManagementRequest"
    ],
    "type":"object",
    "properties":{
        "entityManagementRequest":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ManageStudyEntityDto"
            }
        }
    }
}

Nested Schema : entityManagementRequest

Type: array

Show Source

Array of: object ManageStudyEntityDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ManageStudyEntityDto"
    }
}

Nested Schema : ManageStudyEntityDto

Type: object

Show Source

studyEntities: array studyEntities
studyId(required): string (uuid)

{
    "required":[
        "studyId"
    ],
    "type":"object",
    "properties":{
        "studyId":{
            "type":"string",
            "format":"uuid"
        },
        "studyEntities":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ManageEntityDto"
            }
        }
    }
}

Nested Schema : studyEntities

Type: array

Show Source

Array of: object ManageEntityDto

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ManageEntityDto"
    }
}

Nested Schema : ManageEntityDto

Type: object

Show Source

associationId: string (uuid)
comment: string

Minimum Length: 0

Maximum Length: 2048
entityAction(required): string

Minimum Length: 0

Maximum Length: 25
entityId: string (uuid)
entityName: string

Minimum Length: 0

Maximum Length: 50
entityType(required): string

Minimum Length: 0

Maximum Length: 25
modes: array modes
reason: string

Minimum Length: 0

Maximum Length: 255
targetTenantEntityId: string (uuid)
versionStart: string (date-time)

{
    "required":[
        "entityAction",
        "entityType"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string"
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string"
        },
        "entityId":{
            "type":"string",
            "format":"uuid"
        },
        "entityName":{
            "maxLength":50,
            "minLength":0,
            "type":"string"
        },
        "entityType":{
            "maxLength":25,
            "minLength":0,
            "type":"string"
        },
        "entityAction":{
            "maxLength":25,
            "minLength":0,
            "type":"string"
        },
        "targetTenantEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "modes":{
            "type":"array",
            "items":{
                "type":"string",
                "enum":[
                    "TESTING",
                    "PRODUCTION",
                    "TRAINING",
                    "STUDY_DESIGN"
                ]
            }
        },
        "associationId":{
            "type":"string",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Nested Schema : modes

Type: array

Show Source

Array of: string

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

{
    "type":"array",
    "items":{
        "type":"string",
        "enum":[
            "TESTING",
            "PRODUCTION",
            "TRAINING",
            "STUDY_DESIGN"
        ]
    }
}

Response

Supported Media Types

application/json

204 Response

Successful operation.

400 Response

Bad request.

Root Schema : SDFResponse

Type: object

Show Source

errorData: object ErrorResponseData

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.
result: object result
status: string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string"
        },
        "result":{
            "type":"object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        }
    }
}

Nested Schema : ErrorResponseData

Type: object

Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details.

Show Source

details: string

Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.

Example: User role is missing required permission REPORTING_VIEW. Field: userId
errorCode: string

Application or business-specific error code representing the error type.

Example: REPT_401
errorMessage: string

Human-readable error message describing the failure or issue.

Example: Unauthorized: User does not have access to the requested resource

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Application or business-specific error code representing the error type.",
            "example":"REPT_401"
        },
        "errorMessage":{
            "type":"string",
            "description":"Human-readable error message describing the failure or issue.",
            "example":"Unauthorized: User does not have access to the requested resource"
        },
        "details":{
            "type":"string",
            "description":"Detailed error context or debugging information such as validation error, stack trace, or field/parameter cause.",
            "example":"User role is missing required permission REPORTING_VIEW. Field: userId"
        }
    },
    "description":"Structure representing an error response from the reporting service. Contains an error code, human-readable message, and details."
}

Nested Schema : result

Type: object