REST API for Clinical One Cloud Service

v1.0

post

/ec-site-svc/rest/v1.0/tenantsite/{entityType}/{entityId}/{associationType}/associations

Creates an association between a source entity (Lab, Depot, or Investigator) and an Institution.

Request

Path Parameters

associationType(required): string
Association type in the request. Allowed values: INVESTIGATOR_INSTITUTION (investigator linked to institution), DEPOT_INSTITUTION (depot linked to institution), LAB_INSTITUTION (lab linked to institution).
Example:
```
INVESTIGATOR_INSTITUTION
```
entityId(required): string
Institution, Investigator, Lab or Depot ID.
Example:
```
C36A3197FDEE433FB5547EE83DE99E4B
```
entityType(required): string
Entity type. Allowed values: INSTITUTION (organization entity), INVESTIGATOR (investigator entity), LAB (study lab entity), DEPOT (study depot entity).
Example:
```
INSTITUTION
```

Supported Media Types

application/json

Root Schema : TENANT_SITES_REQUEST_TITLE

Type: object

Title: TENANT_SITES_REQUEST_TITLE

TENANT_SITES_REQUEST_DESC

Show Source

tenantSites: object TENANT_SITE_DTO_TITLE

Title: TENANT_SITE_DTO_TITLE

TENANT_SITE_DTO_DESC

{
    "title":"TENANT_SITES_REQUEST_TITLE",
    "type":"object",
    "properties":{
        "tenantSites":{
            "title":"TENANT_SITE_DTO_TITLE",
            "required":[
                "tenantFirstEntityId",
                "tenantSecondEntityId"
            ],
            "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."
                },
                "id":{
                    "title":"TENANT_SITE_DTO_ID_TITLE",
                    "type":"string",
                    "description":"TENANT_SITE_DTO_ID_DESC",
                    "format":"uuid"
                },
                "versionStart":{
                    "type":"string",
                    "format":"date-time"
                },
                "tenantFirstEntityId":{
                    "title":"TENANT_SITE_DTO_FIRST_ENTITY_ID_TITLE",
                    "type":"string",
                    "description":"TENANT_SITE_DTO_FIRST_ENTITY_ID_DESC",
                    "format":"uuid"
                },
                "tenantSecondEntityId":{
                    "title":"TENANT_SITE_DTO_SECOND_ENTITY_ID_TITLE",
                    "type":"string",
                    "description":"TENANT_SITE_DTO_SECOND_ENTITY_ID_DESC",
                    "format":"uuid"
                }
            },
            "description":"TENANT_SITE_DTO_DESC",
            "example":[
                {
                    "id":"C36A3197FDEE433FB5547EE83DE99E4B"
                }
            ]
        }
    },
    "description":"TENANT_SITES_REQUEST_DESC"
}

Nested Schema : TENANT_SITE_DTO_TITLE

Type: object

Title: TENANT_SITE_DTO_TITLE

TENANT_SITE_DTO_DESC

Show Source

comment: string

Title: Comment

Minimum Length: 0

Maximum Length: 2048

Additional comment captured for the audited update.

Example: Association adjusted after data reconciliation.
id: string (uuid)

Title: TENANT_SITE_DTO_ID_TITLE

TENANT_SITE_DTO_ID_DESC
reason: string

Title: Reason

Minimum Length: 0

Maximum Length: 255

Reason provided for the audited update.

Example: Protocol update requested by study operations.
tenantFirstEntityId(required): string (uuid)

Title: TENANT_SITE_DTO_FIRST_ENTITY_ID_TITLE

TENANT_SITE_DTO_FIRST_ENTITY_ID_DESC
tenantSecondEntityId(required): string (uuid)

Title: TENANT_SITE_DTO_SECOND_ENTITY_ID_TITLE

TENANT_SITE_DTO_SECOND_ENTITY_ID_DESC
versionStart: string (date-time)

{
    "title":"TENANT_SITE_DTO_TITLE",
    "required":[
        "tenantFirstEntityId",
        "tenantSecondEntityId"
    ],
    "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."
        },
        "id":{
            "title":"TENANT_SITE_DTO_ID_TITLE",
            "type":"string",
            "description":"TENANT_SITE_DTO_ID_DESC",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "format":"date-time"
        },
        "tenantFirstEntityId":{
            "title":"TENANT_SITE_DTO_FIRST_ENTITY_ID_TITLE",
            "type":"string",
            "description":"TENANT_SITE_DTO_FIRST_ENTITY_ID_DESC",
            "format":"uuid"
        },
        "tenantSecondEntityId":{
            "title":"TENANT_SITE_DTO_SECOND_ENTITY_ID_TITLE",
            "type":"string",
            "description":"TENANT_SITE_DTO_SECOND_ENTITY_ID_DESC",
            "format":"uuid"
        }
    },
    "description":"TENANT_SITE_DTO_DESC",
    "example":[
        {
            "id":"C36A3197FDEE433FB5547EE83DE99E4B"
        }
    ]
}

Example:

[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]

Examples

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : Contacts

Type: object

Show Source

comment: string

Minimum Length: 0

Maximum Length: 2048

Additional user comment about the latest change.

Example: Association adjusted after data reconciliation.
contactId: string

Minimum Length: 0

Maximum Length: 50

Represents contact id for this record.

Example: SITE-001
contactType(required): string (uuid)

Represents contact type for this record.
degree: string

Minimum Length: 0

Maximum Length: 200

Represents degree for this record.

Example: Sample Value
disbarmentEnd: string (date-time)

Represents disbarment end for this record.

Example: 2026-03-16T12:00:00Z
disbarmentStart: string (date-time)

Represents disbarment start for this record.

Example: 2026-03-16T12:00:00Z
firstName(required): string

Minimum Length: 0

Maximum Length: 100

Represents first name for this record.

Example: Sample Name
id: string (uuid)

Unique identifier for this record.
lastName(required): string

Minimum Length: 0

Maximum Length: 100

Represents last name for this record.

Example: Sample Name
middleName: string

Minimum Length: 0

Maximum Length: 100

Represents middle name for this record.

Example: Sample Name
prefix: string (uuid)

Represents prefix for this record.
prefixCodeValue: string

Represents prefix code value for this record.

Example: Sample Value
primarySpecialityId: string (uuid)

Represents primary speciality id for this record.
reason: string

Minimum Length: 0

Maximum Length: 255

Reason for the latest change made to this record.

Example: Protocol update requested by study operations.
status(required): string (uuid)

Represents status for this record.
statusCodeValue: string

Display value for the status code.

Example: ACTIVE
studyAgnostic(required): string

Represents study agnostic for this record.

Example: N
studyId(required): string

Identifier of the related study.

Example: C36A3197FDEE433FB5547EE83DE99E4B
suffix: string (uuid)

Represents suffix for this record.
suffixCodeValue: string

Represents suffix code value for this record.

Example: Sample Value
taxId: string

Minimum Length: 0

Maximum Length: 50

Represents tax id for this record.

Example: Sample Value
timezone: string

Represents timezone for this record.

Example: UTC
versionStart: string (date-time)

Timestamp when this version became active.

Example: 2026-03-16T12:00:00Z

{
    "required":[
        "contactType",
        "firstName",
        "lastName",
        "status",
        "studyAgnostic",
        "studyId"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":255,
            "minLength":0,
            "type":"string",
            "description":"Reason for the latest change made to this record.",
            "example":"Protocol update requested by study operations."
        },
        "comment":{
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional user comment about the latest change.",
            "example":"Association adjusted after data reconciliation."
        },
        "id":{
            "type":"string",
            "description":"Unique identifier for this record.",
            "format":"uuid"
        },
        "versionStart":{
            "type":"string",
            "description":"Timestamp when this version became active.",
            "format":"date-time",
            "example":"2026-03-16T12:00:00Z"
        },
        "firstName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Represents first name for this record.",
            "example":"Sample Name"
        },
        "lastName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Represents last name for this record.",
            "example":"Sample Name"
        },
        "middleName":{
            "maxLength":100,
            "minLength":0,
            "type":"string",
            "description":"Represents middle name for this record.",
            "example":"Sample Name"
        },
        "suffix":{
            "type":"string",
            "description":"Represents suffix for this record.",
            "format":"uuid"
        },
        "prefix":{
            "type":"string",
            "description":"Represents prefix for this record.",
            "format":"uuid"
        },
        "status":{
            "type":"string",
            "description":"Represents status for this record.",
            "format":"uuid"
        },
        "degree":{
            "maxLength":200,
            "minLength":0,
            "type":"string",
            "description":"Represents degree for this record.",
            "example":"Sample Value"
        },
        "contactId":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Represents contact id for this record.",
            "example":"SITE-001"
        },
        "timezone":{
            "type":"string",
            "description":"Represents timezone for this record.",
            "example":"UTC"
        },
        "taxId":{
            "maxLength":50,
            "minLength":0,
            "type":"string",
            "description":"Represents tax id for this record.",
            "example":"Sample Value"
        },
        "primarySpecialityId":{
            "type":"string",
            "description":"Represents primary speciality id for this record.",
            "format":"uuid"
        },
        "disbarmentStart":{
            "type":"string",
            "description":"Represents disbarment start for this record.",
            "format":"date-time",
            "example":"2026-03-16T12:00:00Z"
        },
        "disbarmentEnd":{
            "type":"string",
            "description":"Represents disbarment end for this record.",
            "format":"date-time",
            "example":"2026-03-16T12:00:00Z"
        },
        "contactType":{
            "type":"string",
            "description":"Represents contact type for this record.",
            "format":"uuid"
        },
        "studyId":{
            "type":"string",
            "description":"Identifier of the related study.",
            "example":"C36A3197FDEE433FB5547EE83DE99E4B"
        },
        "studyAgnostic":{
            "type":"string",
            "description":"Represents study agnostic for this record.",
            "example":"N"
        },
        "suffixCodeValue":{
            "type":"string",
            "description":"Represents suffix code value for this record.",
            "example":"Sample Value"
        },
        "prefixCodeValue":{
            "type":"string",
            "description":"Represents prefix code value for this record.",
            "example":"Sample Value"
        },
        "statusCodeValue":{
            "type":"string",
            "description":"Display value for the status code.",
            "example":"ACTIVE"
        }
    }
}

Examples

400 Response

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

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