1. REST API for Clinical One Cloud Service
  2. Tasks
  3. Sites and Depots
  4. Organizations
  5. Update organization by ID

v1.0

put

/ec-site-svc/rest/v1.0/organizations/{id}

Updates an organization by ID.

Request

Path Parameters
Supported Media Types
Request Body - application/json ()
Root Schema : ORGANIZATION_MODEL_TITLE
Type: object
Title: ORGANIZATION_MODEL_TITLE
ORGANIZATION_MODEL_DESC
Show Source
Nested Schema : ModeDto
Type: object
Title: ModeDto
Represents a mode assignment for an entity.
Show Source
Example:
[
    "test"
]
Nested Schema : EntityAddressAssociationDto
Type: object
Title: EntityAddressAssociationDto
Represents an address linked to an entity.
Show Source
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : ORGANIZATION_DTO_TITLE
Type: object
Title: ORGANIZATION_DTO_TITLE
ORGANIZATION_DTO_DESC
Show Source
  • Title: ORGANIZATION_DTO_CATEGORY_TYPE_CODE_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_CATEGORY_TYPE_CODE_VALUE_DESC
    Example: CATEGORY_CODE
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • Title: ORGANIZATION_DTO_MSA_TITLE
    Minimum Length: 0
    Maximum Length: 1
    ORGANIZATION_DTO_MSA_DESC
    Example: Y
  • Title: ORGANIZATION_DTO_MSA_END_TITLE
    ORGANIZATION_DTO_MSA_END_DESC
    Example: 2026-01-01T00:00:00Z
  • Title: ORGANIZATION_DTO_MSA_START_TITLE
    ORGANIZATION_DTO_MSA_START_DESC
    Example: 2025-01-01T00:00:00Z
  • Minimum Length: 0
    Maximum Length: 500
    Example: Sample Name
  • Title: ORGANIZATION_DTO_ORG_ID_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_ORG_ID_DESC
    Example: ORG-12345
  • Title: ORGANIZATION_DTO_ORG_TYPE_CODE_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_ORG_TYPE_CODE_VALUE_DESC
    Example: ORG_TYPE_CODE
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
  • Title: ORGANIZATION_DTO_STATUS_CODE_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_STATUS_CODE_VALUE_DESC
    Example: Active
  • Title: ORGANIZATION_DTO_SUB_TYPE_CODE_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_SUB_TYPE_CODE_VALUE_DESC
    Example: SUB_TYPE
  • Title: ORGANIZATION_DTO_TAX_ID_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_TAX_ID_DESC
    Example: TAX-12345
  • Title: ORGANIZATION_DTO_TIMEZONE_TITLE
    ORGANIZATION_DTO_TIMEZONE_DESC
    Example: America/New_York
  • Title: ORGANIZATION_DTO_VAT_ID_TITLE
    Minimum Length: 0
    Maximum Length: 50
    ORGANIZATION_DTO_VAT_ID_DESC
    Example: VAT-67890
  • Example: 2026-01-15T10:30:00Z
  • Title: ORGANIZATION_DTO_WEB_URL_TITLE
    Minimum Length: 0
    Maximum Length: 255
    Pattern: [(http(s)?):\/\/(www\.)?a-zA-Z0-9@:%._\+~#=]{2,256}\.[a-z]{2,6}\b([-a-zA-Z0-9@:%_\+.~#?&//=]*)
    ORGANIZATION_DTO_WEB_URL_DESC
    Example: https://acme.example.com
Example:
{
    "id":"B1B8327AFAA6412287106192AB5984EF",
    "name":"Acme CRO"
}
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Example:
[
    {
        "id":"C36A3197FDEE433FB5547EE83DE99E4B"
    }
]
Nested Schema : PROPERTY_DTO_TITLE
Type: object
Title: PROPERTY_DTO_TITLE
PROPERTY_DTO_DESC
Show Source
  • Title: Comment
    Minimum Length: 0
    Maximum Length: 2048
    Additional comment captured for the audited update.
    Example: Association adjusted after data reconciliation.
  • ENTITY_ID_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: PROPERTY_DTO_ENTITY_TYPE_TITLE
    Minimum Length: 0
    Maximum Length: 50
    PROPERTY_DTO_ENTITY_TYPE_DESC
    Example: INSTITUTION
  • Title: PROPERTY_DTO_NAME_TITLE
    Minimum Length: 0
    Maximum Length: 100
    PROPERTY_DTO_NAME_DESC
    Example: LabId
  • Title: PROPERTY_DTO_VALUE_TITLE
    Minimum Length: 0
    Maximum Length: 500
    PROPERTY_DTO_VALUE_DESC
    Example: 2A5E92F1C2D54DDA9F1C0A9E7B3C2D1A
  • Title: Reason
    Minimum Length: 0
    Maximum Length: 255
    Reason provided for the audited update.
    Example: Protocol update requested by study operations.
Examples

Back to Top

Response

Supported Media Types

204 Response

Successful operation.
Body ()
Root Schema : Organizations
Type: object
Show Source
Examples

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
Nested Schema : ErrorResponseData
Type: object
Show Source
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

Back to Top