Jump to

• Request
• Response

Create label groups

post

/ec-ors-svc/rest/v1.0/studies/{studyId}/{mode}/label-groups

Creates label groups by study ID. Rights: OrsInventoryPost and OrsUnblinded.

Request

Path Parameters

• mode(required): string
  Mode of the study, accepts: test, active, or training
• studyId(required): string(uuid)
  ID of the study

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Contains label group request.

Show Source

• countries(required): array countries
  Title: countries

  Minimum Number of Items: 1

  Maximum Number of Items: 2147483647

  Contains country id.
• name(required): string
  Minimum Length: 1

  Maximum Length: 50

  Label group name

  Example: Label1001

{
    "required":[
        "countries",
        "name"
    ],
    "type":"object",
    "properties":{
        "name":{
            "maxLength":"50",
            "minLength":"1",
            "type":"string",
            "description":"Label group name",
            "example":"Label1001"
        },
        "countries":{
            "title":"countries",
            "maxItems":"2147483647",
            "minItems":"1",
            "type":"array",
            "description":"Contains country id.",
            "items":{
                "type":"string",
                "format":"uuid"
            }
        }
    },
    "description":"Contains label group request."
}

Nested Schema : countries

Type: array

Title: countries

Minimum Number of Items: 1

Maximum Number of Items: 2147483647

Contains country id.

Show Source

• Array of: string(uuid)

{
    "title":"countries",
    "maxItems":"2147483647",
    "minItems":"1",
    "type":"array",
    "description":"Contains country id.",
    "items":{
        "type":"string",
        "format":"uuid"
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : IDResponse

Type: object

Response object containing Id.

Show Source

• id: string (uuid)
  Id

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Id",
            "format":"uuid"
        }
    },
    "description":"Response object containing Id."
}

400 Response

Label group already exists. OR Country does not exist in system.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

403 Response

The study identifier does not match any study identifiers in Clinical One.

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

500 Response

Internal server error

Body ()

Root Schema : ORSResponse

Type: object

Common response object.

Show Source

• errorData: object ErrorResponseData
• result: object result
  Result Object
• status: string
  Status of request

  Example: Success
• version: integer (int32)

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status of request",
            "example":"Success"
        },
        "result":{
            "type":"object",
            "description":"Result Object"
        },
        "errorData":{
            "$ref":"#/components/schemas/ErrorResponseData"
        },
        "version":{
            "type":"integer",
            "format":"int32"
        }
    },
    "description":"Common response object."
}

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

Result Object

Nested Schema : details

Type: object

Back to Top