REST API for Clinical One Cloud Service

v1.0

get

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

Retrieves a list of contacts and organization associations by Association ID.

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
```

Query Parameters

limit: integer(int32)

Maximum number of rows to return. Only non-negative integers are accepted.
modeId: string

Mode identifier (UUID) for contact or organization mode mapping.
name: string

Filters contact, institution, lab and depots based on name.
offset: integer(int32)

Zero-based row index to start pagination. Only non-negative integers are accepted.
order: string

Optional query parameter. Sort direction for returned rows. Allowed values: asc, desc, ASC, DESC.

There's no request body for this operation.

Response

Supported Media Types

application/json

200 Response

Successful operation.

Root Schema : TENANT_SITES_DETAILS_RESPONSE_TITLE

Type: object

Title: TENANT_SITES_DETAILS_RESPONSE_TITLE

TENANT_SITES_DETAILS_RESPONSE_DESC

Show Source

associationId: string (uuid)
comment: string

Title: Comment

Minimum Length: 0

Maximum Length: 2048

Additional comment captured for the audited update.

Example: Association adjusted after data reconciliation.
modes: array modes
objectVersionNumber: number

Title: Object Version Number

Internal object version number captured for optimistic locking.

Example: 1
operationType: string

Title: Operation Type

Minimum Length: 1

Maximum Length: 16

Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).

Example: MODIFIED
reason: string

Title: TENANT_SITES_DETAILS_RESPONSE_REASON_TITLE

TENANT_SITES_DETAILS_RESPONSE_REASON_DESC

Example: Association active
reasonForInvalidAssoc: object REASON_FOR_INVALID_ASSOCIATION_TITLE

Title: REASON_FOR_INVALID_ASSOCIATION_TITLE

REASON_FOR_INVALID_ASSOCIATION_DESC
softwareVersionNumber: number

Title: Software Version Number

Software version number captured when the record was updated.

Example: 1
studySitesCount: integer (int32)

Title: TENANT_SITES_DETAILS_RESPONSE_STUDY_SITES_COUNT_TITLE

TENANT_SITES_DETAILS_RESPONSE_STUDY_SITES_COUNT_DESC

Example: 5
tenantFirstEntityId: string (uuid)
tenantFirstEntityName: string

Title: TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_TITLE

TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_DESC

Example: Acme Research
tenantFirstEntityStatus: string (uuid)
tenantSecondEntityId: string (uuid)
tenantSecondEntityName: string

Title: TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_TITLE

TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_DESC

Example: Beta Institution
tenantSecondEntityStatus: string (uuid)
userId: string (uuid)

Title: User ID

Identifier of the user who performed the audited action.
valid: boolean

Example: true
versionEnd: string (date-time)

Title: Version End

Timestamp when the version ended.

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

{
    "title":"TENANT_SITES_DETAILS_RESPONSE_TITLE",
    "type":"object",
    "properties":{
        "reason":{
            "title":"TENANT_SITES_DETAILS_RESPONSE_REASON_TITLE",
            "type":"string",
            "description":"TENANT_SITES_DETAILS_RESPONSE_REASON_DESC",
            "example":"Association active"
        },
        "comment":{
            "title":"Comment",
            "maxLength":2048,
            "minLength":0,
            "type":"string",
            "description":"Additional comment captured for the audited update.",
            "example":"Association adjusted after data reconciliation."
        },
        "versionEnd":{
            "title":"Version End",
            "type":"string",
            "description":"Timestamp when the version ended.",
            "format":"date-time",
            "example":"2026-03-30T12:00:00Z"
        },
        "operationType":{
            "title":"Operation Type",
            "maxLength":16,
            "minLength":1,
            "type":"string",
            "description":"Operation applied to the record. Allowed values: CREATED (record was added), MODIFIED (record was updated), REMOVED (record was logically removed).",
            "example":"MODIFIED"
        },
        "userId":{
            "title":"User ID",
            "type":"string",
            "description":"Identifier of the user who performed the audited action.",
            "format":"uuid"
        },
        "objectVersionNumber":{
            "title":"Object Version Number",
            "type":"number",
            "description":"Internal object version number captured for optimistic locking.",
            "example":1
        },
        "softwareVersionNumber":{
            "title":"Software Version Number",
            "type":"number",
            "description":"Software version number captured when the record was updated.",
            "example":1
        },
        "tenantFirstEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityId":{
            "type":"string",
            "format":"uuid"
        },
        "associationId":{
            "type":"string",
            "format":"uuid"
        },
        "tenantFirstEntityName":{
            "title":"TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_TITLE",
            "type":"string",
            "description":"TENANT_SITES_DETAILS_RESPONSE_FIRST_ENTITY_NAME_DESC",
            "example":"Acme Research"
        },
        "tenantSecondEntityName":{
            "title":"TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_TITLE",
            "type":"string",
            "description":"TENANT_SITES_DETAILS_RESPONSE_SECOND_ENTITY_NAME_DESC",
            "example":"Beta Institution"
        },
        "studySitesCount":{
            "title":"TENANT_SITES_DETAILS_RESPONSE_STUDY_SITES_COUNT_TITLE",
            "type":"integer",
            "description":"TENANT_SITES_DETAILS_RESPONSE_STUDY_SITES_COUNT_DESC",
            "format":"int32",
            "example":5
        },
        "tenantFirstEntityStatus":{
            "type":"string",
            "format":"uuid"
        },
        "tenantSecondEntityStatus":{
            "type":"string",
            "format":"uuid"
        },
        "reasonForInvalidAssoc":{
            "title":"REASON_FOR_INVALID_ASSOCIATION_TITLE",
            "type":"object",
            "properties":{
                "context":{
                    "title":"REASON_FOR_INVALID_ASSOCIATION_CONTEXT_TITLE",
                    "type":"string",
                    "description":"REASON_FOR_INVALID_ASSOCIATION_CONTEXT_DESC",
                    "example":"entityType"
                },
                "message":{
                    "title":"REASON_FOR_INVALID_ASSOCIATION_MESSAGE_TITLE",
                    "type":"string",
                    "description":"REASON_FOR_INVALID_ASSOCIATION_MESSAGE_DESC",
                    "example":"Entity not valid for transfer"
                }
            },
            "description":"REASON_FOR_INVALID_ASSOCIATION_DESC",
            "example":"Invalid association for selected entities."
        },
        "modes":{
            "type":"array",
            "example":[
                "B1B8327AFAA6412287106192AB5984EF"
            ],
            "items":{
                "type":"string",
                "format":"uuid"
            }
        },
        "valid":{
            "type":"boolean",
            "example":true
        }
    },
    "description":"TENANT_SITES_DETAILS_RESPONSE_DESC"
}

Nested Schema : modes

Type: array

Show Source

Array of: string(uuid)

{
    "type":"array",
    "example":[
        "B1B8327AFAA6412287106192AB5984EF"
    ],
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Example:

[
    "B1B8327AFAA6412287106192AB5984EF"
]

Nested Schema : REASON_FOR_INVALID_ASSOCIATION_TITLE

Type: object

Title: REASON_FOR_INVALID_ASSOCIATION_TITLE

REASON_FOR_INVALID_ASSOCIATION_DESC

Show Source

context: string

Title: REASON_FOR_INVALID_ASSOCIATION_CONTEXT_TITLE

REASON_FOR_INVALID_ASSOCIATION_CONTEXT_DESC

Example: entityType
message: string

Title: REASON_FOR_INVALID_ASSOCIATION_MESSAGE_TITLE

REASON_FOR_INVALID_ASSOCIATION_MESSAGE_DESC

Example: Entity not valid for transfer

{
    "title":"REASON_FOR_INVALID_ASSOCIATION_TITLE",
    "type":"object",
    "properties":{
        "context":{
            "title":"REASON_FOR_INVALID_ASSOCIATION_CONTEXT_TITLE",
            "type":"string",
            "description":"REASON_FOR_INVALID_ASSOCIATION_CONTEXT_DESC",
            "example":"entityType"
        },
        "message":{
            "title":"REASON_FOR_INVALID_ASSOCIATION_MESSAGE_TITLE",
            "type":"string",
            "description":"REASON_FOR_INVALID_ASSOCIATION_MESSAGE_DESC",
            "example":"Entity not valid for transfer"
        }
    },
    "description":"REASON_FOR_INVALID_ASSOCIATION_DESC",
    "example":"Invalid association for selected entities."
}

Example:

Invalid association for selected entities.

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