Jump to

• Request
• Response

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

Request Body - 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."
                },
                "objectVersionNumber":{
                    "type":"number"
                },
                "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
• objectVersionNumber: number
• 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."
        },
        "objectVersionNumber":{
            "type":"number"
        },
        "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

Select an example Create Tenant Sites Request

Back to Top

Response

Supported Media Types

• application/json

200 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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

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 : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example Create Tenant Sites 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
  Title: ErrorResponseData

  Error Response Details Information
• 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

Title: ErrorResponseData

Error Response Details Information

Show Source

• details: object Object
  Title: Object

  Object with error details information.
• errorCode: string
  Error code which is stored in ErrorCode enum. Example : C1-003

  Example: C1-003
• errorMessage: string
  Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved

  Example: Cannot modify object after a study version has been approved

{
    "title":"ErrorResponseData",
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":"Error code which is stored in ErrorCode enum. Example : C1-003",
            "example":"C1-003"
        },
        "errorMessage":{
            "type":"string",
            "description":"Error message which is stored in service property file. Example : Cannot modify object after a study version has been approved",
            "example":"Cannot modify object after a study version has been approved"
        },
        "details":{
            "title":"Object",
            "type":"object",
            "description":"Object with error details information.",
            "example":{
                "field":"studyId",
                "reason":"Invalid value"
            }
        }
    },
    "description":"Error Response Details Information"
}

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 : Object

Type: object

Title: Object

Object with error details information.

Example:

{
    "field":"studyId",
    "reason":"Invalid value"
}

Examples

Select an example Bad Request Response

Back to Top