Jump to

• Request
• Response

Manage all associated entities with given contact or organization

put

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

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

Request

Path Parameters

• entityType(required): string
  Contact or Organisation type, allowed types are Investigator, Institution, Lab or Depot.

  Allowed Values: [ "ORGANIZATION", "CONTACT", "FACILITY", "INSTITUTION", "INVESTIGATOR", "LAB", "DEPOT" ]
• srcEntityId(required): string
  Contact or Organisation Id, entity can be either of Investigator, Institution, Lab or Depot.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• entityManagementActionRequest(required): object EntityManagementActionRequestDto

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

Nested Schema : EntityManagementActionRequestDto

Type: object

Show Source

• comment: string
  Minimum Length: 0

  Maximum Length: 2048
• entityAction(required): string
  Minimum Length: 0

  Maximum Length: 25
• reason: string
  Minimum Length: 0

  Maximum Length: 255
• targetTenantEntityId: string (uuid)

{
    "required":[
        "entityAction"
    ],
    "type":"object",
    "properties":{
        "reason":{
            "maxLength":"255",
            "minLength":"0",
            "type":"string"
        },
        "comment":{
            "maxLength":"2048",
            "minLength":"0",
            "type":"string"
        },
        "entityAction":{
            "maxLength":"25",
            "minLength":"0",
            "type":"string"
        },
        "targetTenantEntityId":{
            "type":"string",
            "format":"uuid"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

204 Response

Successful operation.

400 Response

Bad request.

Body ()

Root Schema : SDFResponse

Type: object

Show Source

• errorData: object ErrorResponseData
• result: object result
• status: string

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

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

Nested Schema : details

Type: object

Back to Top