Jump to

• Request
• Response

v1.0

put

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

Manages all contact or organization associations 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_ACTION_REQUEST_TITLE

Type: object

Title: ENTITY_MANAGEMENT_ACTION_REQUEST_TITLE

ENTITY_MANAGEMENT_ACTION_REQUEST_DESC

Show Source

• entityManagementActionRequest(required): object ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_TITLE
  Title: ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_TITLE

  ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_DESC

{
    "title":"ENTITY_MANAGEMENT_ACTION_REQUEST_TITLE",
    "required":[
        "entityManagementActionRequest"
    ],
    "type":"object",
    "properties":{
        "entityManagementActionRequest":{
            "$ref":"#/components/schemas/EntityManagementActionRequestDto"
        }
    },
    "description":"ENTITY_MANAGEMENT_ACTION_REQUEST_DESC"
}

Nested Schema : ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_TITLE

Type: object

Title: ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_TITLE

ENTITY_MANAGEMENT_ACTION_REQUEST_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.
• entityAction(required): string
  Title: ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_ACTION_TITLE

  Minimum Length: 0

  Maximum Length: 25

  ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_ACTION_DESC

  Example: TRANSFER
• 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":"ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_TITLE",
    "required":[
        "entityAction"
    ],
    "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."
        },
        "entityAction":{
            "title":"ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_ACTION_TITLE",
            "maxLength":25,
            "minLength":0,
            "type":"string",
            "description":"ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_ACTION_DESC",
            "example":"TRANSFER"
        },
        "targetTenantEntityId":{
            "type":"string",
            "format":"uuid"
        }
    },
    "description":"ENTITY_MANAGEMENT_ACTION_REQUEST_DTO_DESC",
    "example":{
        "targetTenantEntityId":"B1B8327AFAA6412287106192AB5984EF"
    }
}

Example:

{
    "targetTenantEntityId":"B1B8327AFAA6412287106192AB5984EF"
}

Examples

Select an example Manage All Study Mapped 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