62961 lines
2.0 MiB
62961 lines
2.0 MiB
{
|
|
"openapi": "3.0.2",
|
|
"info": {
|
|
"title": "Clinical Study",
|
|
"description": "The Clinical Study interface enables an external system to read study data and demand forecast data, add a study entity, and submit the results of enrollment forecast calculations.",
|
|
"version": "1.1.0"
|
|
},
|
|
"x-sap-api-type": "ODATAV4",
|
|
"x-sap-shortText": "Retrieve full details of a study and its forecasts, add a study, and submit enrollment calculation results.",
|
|
"servers": [
|
|
{
|
|
"url": "https://core-icsm-provider-prod.cfapps.eu10-004.hana.ondemand.com/api/config/v1",
|
|
"description": "Production server for Intelligent Clinical Supply Management"
|
|
}
|
|
],
|
|
"tags": [
|
|
{
|
|
"name": "Blinding Groups"
|
|
},
|
|
{
|
|
"name": "Blinding Scenarios"
|
|
},
|
|
{
|
|
"name": "Blinding Scenarios texts"
|
|
},
|
|
{
|
|
"name": "Cached Distributing Templates"
|
|
},
|
|
{
|
|
"name": "Cached MRP Areas"
|
|
},
|
|
{
|
|
"name": "Cached Molecules"
|
|
},
|
|
{
|
|
"name": "Cached Ref Kit Type Items"
|
|
},
|
|
{
|
|
"name": "Cached Ref Kit Types"
|
|
},
|
|
{
|
|
"name": "Cached Site Groups"
|
|
},
|
|
{
|
|
"name": "Cached Site Groups texts"
|
|
},
|
|
{
|
|
"name": "Consolidated Site Groups"
|
|
},
|
|
{
|
|
"name": "Contact Roles"
|
|
},
|
|
{
|
|
"name": "Contact Roles texts"
|
|
},
|
|
{
|
|
"name": "Contacts"
|
|
},
|
|
{
|
|
"name": "Cost Object"
|
|
},
|
|
{
|
|
"name": "Cost Object Types"
|
|
},
|
|
{
|
|
"name": "Cost Object Types texts"
|
|
},
|
|
{
|
|
"name": "Cost Object texts"
|
|
},
|
|
{
|
|
"name": "Country"
|
|
},
|
|
{
|
|
"name": "Country texts"
|
|
},
|
|
{
|
|
"name": "Demand Forecast Demand"
|
|
},
|
|
{
|
|
"name": "Demand Forecast Enrollment"
|
|
},
|
|
{
|
|
"name": "Demand Forecast Site Group Statuses"
|
|
},
|
|
{
|
|
"name": "Demand Forecast Site Group Statuses texts"
|
|
},
|
|
{
|
|
"name": "Demand Forecast Visits"
|
|
},
|
|
{
|
|
"name": "Demand Forecasts"
|
|
},
|
|
{
|
|
"name": "Enrollment Curves"
|
|
},
|
|
{
|
|
"name": "Enrollment Curves texts"
|
|
},
|
|
{
|
|
"name": "Enrollment Data Points"
|
|
},
|
|
{
|
|
"name": "External Enrollment Time Series"
|
|
},
|
|
{
|
|
"name": "External Identifiers"
|
|
},
|
|
{
|
|
"name": "Kit Type Country Label Group Element"
|
|
},
|
|
{
|
|
"name": "Kit Type Country Regulatory Statuses"
|
|
},
|
|
{
|
|
"name": "Kit Type Label Group Assignments"
|
|
},
|
|
{
|
|
"name": "Kit Type Material Label Group Assignments"
|
|
},
|
|
{
|
|
"name": "Kit Type Molecules"
|
|
},
|
|
{
|
|
"name": "Kit Type Site Group Depots"
|
|
},
|
|
{
|
|
"name": "Kit Type Treatment Assignments"
|
|
},
|
|
{
|
|
"name": "Kit Type Tree Element"
|
|
},
|
|
{
|
|
"name": "Kit Types"
|
|
},
|
|
{
|
|
"name": "Label Group Country Assignments"
|
|
},
|
|
{
|
|
"name": "Label Groups"
|
|
},
|
|
{
|
|
"name": "Lead Molecules"
|
|
},
|
|
{
|
|
"name": "Lead Molecules texts"
|
|
},
|
|
{
|
|
"name": "Lean Study Demand Bucket Values"
|
|
},
|
|
{
|
|
"name": "Lean Study Demand Buckets"
|
|
},
|
|
{
|
|
"name": "Lean Study Demands"
|
|
},
|
|
{
|
|
"name": "Lean Study Demands Presentation"
|
|
},
|
|
{
|
|
"name": "Lean Study Schedule Agreement Statuses"
|
|
},
|
|
{
|
|
"name": "Lean Study Schedule Agreement Statuses texts"
|
|
},
|
|
{
|
|
"name": "Lean Study Site Groups"
|
|
},
|
|
{
|
|
"name": "Materials"
|
|
},
|
|
{
|
|
"name": "Materials View"
|
|
},
|
|
{
|
|
"name": "Persons"
|
|
},
|
|
{
|
|
"name": "Push To S P Log Entries"
|
|
},
|
|
{
|
|
"name": "Randomization Group Site Groups"
|
|
},
|
|
{
|
|
"name": "Randomization Groups"
|
|
},
|
|
{
|
|
"name": "Ratio Mode"
|
|
},
|
|
{
|
|
"name": "Ratio Mode texts"
|
|
},
|
|
{
|
|
"name": "Recalculation Method"
|
|
},
|
|
{
|
|
"name": "Recalculation Method Fallback Used"
|
|
},
|
|
{
|
|
"name": "Recalculation Method Fallback Used texts"
|
|
},
|
|
{
|
|
"name": "Recalculation Method texts"
|
|
},
|
|
{
|
|
"name": "Scenarios"
|
|
},
|
|
{
|
|
"name": "Site Groups"
|
|
},
|
|
{
|
|
"name": "Studies"
|
|
},
|
|
{
|
|
"name": "Study Actuals Source Settings"
|
|
},
|
|
{
|
|
"name": "Study Demands"
|
|
},
|
|
{
|
|
"name": "Study Dispensation Treatment Assignments"
|
|
},
|
|
{
|
|
"name": "Study Enrollment Curves"
|
|
},
|
|
{
|
|
"name": "Study External Identifier Assignments"
|
|
},
|
|
{
|
|
"name": "Study Materials"
|
|
},
|
|
{
|
|
"name": "Study Phases"
|
|
},
|
|
{
|
|
"name": "Study Phases texts"
|
|
},
|
|
{
|
|
"name": "Study Protocols"
|
|
},
|
|
{
|
|
"name": "Study Regulatory Statuses"
|
|
},
|
|
{
|
|
"name": "Study Regulatory Statuses texts"
|
|
},
|
|
{
|
|
"name": "Study Scenario Additional Demand"
|
|
},
|
|
{
|
|
"name": "Study Scenario Site Groups"
|
|
},
|
|
{
|
|
"name": "Study Scenario Site Seedings"
|
|
},
|
|
{
|
|
"name": "Study Scenario Status"
|
|
},
|
|
{
|
|
"name": "Study Scenario Status texts"
|
|
},
|
|
{
|
|
"name": "Study Statuses"
|
|
},
|
|
{
|
|
"name": "Study Statuses texts"
|
|
},
|
|
{
|
|
"name": "Study Timeline Kit Type Assignments"
|
|
},
|
|
{
|
|
"name": "Study Timeline Periods"
|
|
},
|
|
{
|
|
"name": "Study Timeline Schedules"
|
|
},
|
|
{
|
|
"name": "Study Timeline Treatments"
|
|
},
|
|
{
|
|
"name": "Study Transition Statuses"
|
|
},
|
|
{
|
|
"name": "Study Transitions"
|
|
},
|
|
{
|
|
"name": "Study Treatment Dispensation Events"
|
|
},
|
|
{
|
|
"name": "Study Treatment Groups"
|
|
},
|
|
{
|
|
"name": "Study Treatment Periods"
|
|
},
|
|
{
|
|
"name": "Study Treatment Schedule DeSyncTGs"
|
|
},
|
|
{
|
|
"name": "Study Treatment Schedule Treatments"
|
|
},
|
|
{
|
|
"name": "Study Treatment Schedules"
|
|
},
|
|
{
|
|
"name": "Study Treatment Switches"
|
|
},
|
|
{
|
|
"name": "Study Treatments"
|
|
},
|
|
{
|
|
"name": "Study Types"
|
|
},
|
|
{
|
|
"name": "Study Types texts"
|
|
},
|
|
{
|
|
"name": "Therapeutic Areas"
|
|
},
|
|
{
|
|
"name": "Therapeutic Areas texts"
|
|
},
|
|
{
|
|
"name": "Treatment Group Site Groups"
|
|
}
|
|
],
|
|
"paths": {
|
|
"/$batch": {},
|
|
"/BlindingGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of blinding groups.",
|
|
"tags": [
|
|
"Blinding Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"blindingGroupID",
|
|
"blindingGroupID desc",
|
|
"blindingGroupDescription",
|
|
"blindingGroupDescription desc",
|
|
"blindedDescription",
|
|
"blindedDescription desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingGroupID",
|
|
"blindingGroupDescription",
|
|
"blindedDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of BlindingGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single blinding group.",
|
|
"tags": [
|
|
"Blinding Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingGroupID",
|
|
"blindingGroupDescription",
|
|
"blindedDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingGroups({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a blinding group.",
|
|
"tags": [
|
|
"Blinding Groups",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios": {
|
|
"get": {
|
|
"summary": "Retrieve a list of blinding scenarios.",
|
|
"tags": [
|
|
"Blinding Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"blindingStrategyDescription",
|
|
"blindingStrategyDescription desc",
|
|
"isObsolete",
|
|
"isObsolete desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingStrategyDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding scenarios.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of BlindingScenarios",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingScenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single blinding scenario.",
|
|
"tags": [
|
|
"Blinding Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingStrategyDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingScenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a blinding strategy.",
|
|
"tags": [
|
|
"Blinding Scenarios",
|
|
"Blinding Scenarios texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"blindingStrategyDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized blinding strategy description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingScenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a blinding scenario.",
|
|
"tags": [
|
|
"Blinding Scenarios",
|
|
"Blinding Scenarios texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"blindingStrategyDescription",
|
|
"blindingStrategyDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"blindingStrategyDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of BlindingScenarios_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of blinding scenarios_texts.",
|
|
"tags": [
|
|
"Blinding Scenarios texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"blindingStrategyDescription",
|
|
"blindingStrategyDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"blindingStrategyDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding scenarios_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of BlindingScenarios_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/BlindingScenarios_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of BlindingScenarios_texts entity.",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single blinding scenarios_text.",
|
|
"tags": [
|
|
"Blinding Scenarios texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"blindingStrategyDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding scenarios_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedDistributingTemplates": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached distribution templates.",
|
|
"tags": [
|
|
"Cached Distributing Templates"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached distribution templates.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedDistributingTemplates",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedDistributingTemplates('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached distribution template.",
|
|
"tags": [
|
|
"Cached Distributing Templates"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached distribution template.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedMRPAreas": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached MRP areas.",
|
|
"tags": [
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"ID",
|
|
"ID desc",
|
|
"mrpAreaText",
|
|
"mrpAreaText desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached MRP areas.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedMRPAreas",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedMRPAreas('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached MRP area.",
|
|
"tags": [
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached MRP area.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedMolecules": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached molecules.",
|
|
"tags": [
|
|
"Cached Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"MoleculeUUID",
|
|
"MoleculeUUID desc",
|
|
"MoleculeId",
|
|
"MoleculeId desc",
|
|
"Description",
|
|
"Description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"MoleculeId",
|
|
"Description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached molecules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedMolecules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedMolecules({MoleculeUUID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: MoleculeUUID",
|
|
"in": "path",
|
|
"name": "MoleculeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached molecule.",
|
|
"tags": [
|
|
"Cached Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"MoleculeId",
|
|
"Description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypeItems": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached reference kit type items.",
|
|
"tags": [
|
|
"Cached Ref Kit Type Items"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"MoleculeUUID",
|
|
"MoleculeUUID desc",
|
|
"RefKitTypeUUID",
|
|
"RefKitTypeUUID desc",
|
|
"MoleculeId",
|
|
"MoleculeId desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"RefKitTypeUUID",
|
|
"MoleculeId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"Molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached reference kit type items.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedRefKitTypeItems",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypeItems(MoleculeUUID={MoleculeUUID},RefKitTypeUUID={RefKitTypeUUID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: MoleculeUUID",
|
|
"in": "path",
|
|
"name": "MoleculeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: RefKitTypeUUID",
|
|
"in": "path",
|
|
"name": "RefKitTypeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached reference kit type item.",
|
|
"tags": [
|
|
"Cached Ref Kit Type Items"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"RefKitTypeUUID",
|
|
"MoleculeId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"Molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached reference kit type item.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypeItems(MoleculeUUID={MoleculeUUID},RefKitTypeUUID={RefKitTypeUUID})/Molecule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: MoleculeUUID",
|
|
"in": "path",
|
|
"name": "MoleculeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: RefKitTypeUUID",
|
|
"in": "path",
|
|
"name": "RefKitTypeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve molecule of a cached reference kit type item.",
|
|
"tags": [
|
|
"Cached Ref Kit Type Items",
|
|
"Cached Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"MoleculeId",
|
|
"Description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypes": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached reference kit types.",
|
|
"tags": [
|
|
"Cached Ref Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"RefKitTypeUUID",
|
|
"RefKitTypeUUID desc",
|
|
"RefKitID",
|
|
"RefKitID desc",
|
|
"INNDescription",
|
|
"INNDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"RefKitTypeUUID",
|
|
"RefKitID",
|
|
"INNDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"KitTypeItems"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached reference kit types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedRefKitTypes",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypes({RefKitTypeUUID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: RefKitTypeUUID",
|
|
"in": "path",
|
|
"name": "RefKitTypeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached reference kit type.",
|
|
"tags": [
|
|
"Cached Ref Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"RefKitTypeUUID",
|
|
"RefKitID",
|
|
"INNDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"KitTypeItems"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached reference kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedRefKitTypes({RefKitTypeUUID})/KitTypeItems": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: RefKitTypeUUID",
|
|
"in": "path",
|
|
"name": "RefKitTypeUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type items of a cached reference kit type.",
|
|
"tags": [
|
|
"Cached Ref Kit Types",
|
|
"Cached Ref Kit Type Items"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"MoleculeUUID",
|
|
"MoleculeUUID desc",
|
|
"RefKitTypeUUID",
|
|
"RefKitTypeUUID desc",
|
|
"MoleculeId",
|
|
"MoleculeId desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"RefKitTypeUUID",
|
|
"MoleculeId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"Molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type items.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedRefKitTypeItems",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached site groups.",
|
|
"tags": [
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc",
|
|
"country_countryId",
|
|
"country_countryId desc",
|
|
"materialPooling",
|
|
"materialPooling desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached site group.",
|
|
"tags": [
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups('{ID}')/country": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve country of a cached site group.",
|
|
"tags": [
|
|
"Cached Site Groups",
|
|
"Country"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"countryId",
|
|
"countryName",
|
|
"daysOffset"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a cached site group.",
|
|
"tags": [
|
|
"Cached Site Groups",
|
|
"Cached Site Groups texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description of a cached site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a cached site group.",
|
|
"tags": [
|
|
"Cached Site Groups",
|
|
"Cached Site Groups texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized descriptions.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedSiteGroups_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cached site groups_texts.",
|
|
"tags": [
|
|
"Cached Site Groups texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached site groups_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CachedSiteGroups_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CachedSiteGroups_texts(locale='{locale}',ID='{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cached site groups_text.",
|
|
"tags": [
|
|
"Cached Site Groups texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cached site groups_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ConsolidatedSiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of consolidated site groups.",
|
|
"tags": [
|
|
"Consolidated Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"lastSubjectLastVisit",
|
|
"lastSubjectLastVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"activatedSites",
|
|
"activatedSites desc",
|
|
"isLinkedCTMS",
|
|
"isLinkedCTMS desc",
|
|
"isStudyCompleted",
|
|
"isStudyCompleted desc",
|
|
"ctmsPlannedEnrollment",
|
|
"ctmsPlannedEnrollment desc",
|
|
"ctmsFirstSubjectFirstVisit",
|
|
"ctmsFirstSubjectFirstVisit desc",
|
|
"ctmsLastSubjectFirstVisit",
|
|
"ctmsLastSubjectFirstVisit desc",
|
|
"ctmsPlannedSites",
|
|
"ctmsPlannedSites desc",
|
|
"ctmsActualSites",
|
|
"ctmsActualSites desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"active",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"scenario_ID",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"isLinkedCTMS",
|
|
"isStudyCompleted",
|
|
"ctmsPlannedEnrollment",
|
|
"ctmsFirstSubjectFirstVisit",
|
|
"ctmsLastSubjectFirstVisit",
|
|
"ctmsPlannedSites",
|
|
"ctmsActualSites"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved consolidated site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ConsolidatedSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ConsolidatedSiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of ConsolidatedSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single consolidated site group.",
|
|
"tags": [
|
|
"Consolidated Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"active",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"scenario_ID",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"isLinkedCTMS",
|
|
"isStudyCompleted",
|
|
"ctmsPlannedEnrollment",
|
|
"ctmsFirstSubjectFirstVisit",
|
|
"ctmsLastSubjectFirstVisit",
|
|
"ctmsPlannedSites",
|
|
"ctmsActualSites"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved consolidated site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ContactRoles": {
|
|
"get": {
|
|
"summary": "Retrieve a list of contact roles.",
|
|
"tags": [
|
|
"Contact Roles"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"roleName",
|
|
"roleName desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact roles.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ContactRoles",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ContactRoles('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single contact role.",
|
|
"tags": [
|
|
"Contact Roles"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact role.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ContactRoles('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized name of a contact role.",
|
|
"tags": [
|
|
"Contact Roles",
|
|
"Contact Roles texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized contact role name.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ContactRoles_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of contact role names.",
|
|
"tags": [
|
|
"Contact Roles texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"roleName",
|
|
"roleName desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact role names.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ContactRoles_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ContactRoles_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts (UUID).",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single contact role name.",
|
|
"tags": [
|
|
"Contact Roles texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact role name.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Contacts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of contacts.",
|
|
"tags": [
|
|
"Contacts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"parentID",
|
|
"parentID desc",
|
|
"description",
|
|
"description desc",
|
|
"firstName",
|
|
"firstName desc",
|
|
"lastName",
|
|
"lastName desc",
|
|
"email",
|
|
"email desc",
|
|
"phoneNumber",
|
|
"phoneNumber desc",
|
|
"cachedPerson_personNumber",
|
|
"cachedPerson_personNumber desc",
|
|
"userSource",
|
|
"userSource desc",
|
|
"role_ID",
|
|
"role_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"parentID",
|
|
"description",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber",
|
|
"cachedPerson_personNumber",
|
|
"userSource",
|
|
"role_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"role",
|
|
"person"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contacts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Contacts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Contacts({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Contacts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single contact.",
|
|
"tags": [
|
|
"Contacts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"parentID",
|
|
"description",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber",
|
|
"cachedPerson_personNumber",
|
|
"userSource",
|
|
"role_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"role",
|
|
"person"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Contacts({ID})/person": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Contacts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a contact's personal data.",
|
|
"tags": [
|
|
"Contacts",
|
|
"Persons"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"personNumber",
|
|
"userSource",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved personal contact data.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Contacts({ID})/role": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Contacts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve role of a contact.",
|
|
"tags": [
|
|
"Contacts",
|
|
"Contact Roles"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"roleName"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contact role.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cost object.",
|
|
"tags": [
|
|
"Cost Object"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"ID",
|
|
"ID desc",
|
|
"type",
|
|
"type desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"typeText",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObject",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject(ID='{ID}',type={type})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: type",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cost object.",
|
|
"tags": [
|
|
"Cost Object"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"typeText",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject(ID='{ID}',type={type})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: type",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a cost object.",
|
|
"tags": [
|
|
"Cost Object",
|
|
"Cost Object texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized cost object description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject(ID='{ID}',type={type})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: type",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a cost object.",
|
|
"tags": [
|
|
"Cost Object",
|
|
"Cost Object texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"type",
|
|
"type desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized descriptions.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObject_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject(ID='{ID}',type={type})/typeText": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: type",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve type description of a cost object.",
|
|
"tags": [
|
|
"Cost Object",
|
|
"Cost Object Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved type description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cost object types.",
|
|
"tags": [
|
|
"Cost Object Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObjectTypes",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of CostObjectTypes entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cost object type.",
|
|
"tags": [
|
|
"Cost Object Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of CostObjectTypes entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a cost object type.",
|
|
"tags": [
|
|
"Cost Object Types",
|
|
"Cost Object Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized cost object type description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of CostObjectTypes entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a cost object type.",
|
|
"tags": [
|
|
"Cost Object Types",
|
|
"Cost Object Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObjectTypes_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cost object types_texts.",
|
|
"tags": [
|
|
"Cost Object Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object types_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObjectTypes_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObjectTypes_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cost object types_text.",
|
|
"tags": [
|
|
"Cost Object Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object types_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of cost object_texts.",
|
|
"tags": [
|
|
"Cost Object texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"type",
|
|
"type desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of CostObject_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/CostObject_texts(locale='{locale}',ID='{ID}',type={type})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: type",
|
|
"in": "path",
|
|
"name": "type",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single cost object_text.",
|
|
"tags": [
|
|
"Cost Object texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country": {
|
|
"get": {
|
|
"summary": "Retrieve a list of countries.",
|
|
"tags": [
|
|
"Country"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"refreshedAt desc",
|
|
"countryId",
|
|
"countryId desc",
|
|
"countryName",
|
|
"countryName desc",
|
|
"daysOffset",
|
|
"daysOffset desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"countryId",
|
|
"countryName",
|
|
"daysOffset"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Country",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country('{countryId}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: countryId",
|
|
"in": "path",
|
|
"name": "countryId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single country.",
|
|
"tags": [
|
|
"Country"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"countryId",
|
|
"countryName",
|
|
"daysOffset"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country('{countryId}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: countryId",
|
|
"in": "path",
|
|
"name": "countryId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized name of a country.",
|
|
"tags": [
|
|
"Country",
|
|
"Country texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"countryId",
|
|
"countryName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized country name.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country('{countryId}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: countryId",
|
|
"in": "path",
|
|
"name": "countryId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of texts of a country.",
|
|
"tags": [
|
|
"Country",
|
|
"Country texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"countryId",
|
|
"countryId desc",
|
|
"countryName",
|
|
"countryName desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"countryId",
|
|
"countryName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Country_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of country_texts.",
|
|
"tags": [
|
|
"Country texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"countryId",
|
|
"countryId desc",
|
|
"countryName",
|
|
"countryName desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"countryId",
|
|
"countryName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Country_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Country_texts(locale='{locale}',countryId='{countryId}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: countryId",
|
|
"in": "path",
|
|
"name": "countryId",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single country_text.",
|
|
"tags": [
|
|
"Country texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"countryId",
|
|
"countryName"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastDemand": {
|
|
"get": {
|
|
"summary": "Retrieve demand data from all demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Demand"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"depot",
|
|
"depot desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"visitPeriodID",
|
|
"visitPeriodID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc",
|
|
"depotDescription",
|
|
"depotDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"depot",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"visitPeriodID",
|
|
"kitType_ID",
|
|
"kitTypeID",
|
|
"kitTypeDescription",
|
|
"materialID",
|
|
"materialDescription",
|
|
"demandForecast_ID",
|
|
"planningFigureDescription",
|
|
"depotDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"mrpArea",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup",
|
|
"treatmentPeriod",
|
|
"kitType"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand data from demand forecasts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastDemand",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment": {
|
|
"get": {
|
|
"summary": "Retrieve enrollment data from all demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"depot",
|
|
"depot desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureDescription",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"depot",
|
|
"depotDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"demandForecast_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast enrollment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastEnrollment",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastEnrollment entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve individual enrollment entries, with related data, from demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureDescription",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"depot",
|
|
"depotDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"demandForecast_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast enrollment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment({ID})/randomizationGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastEnrollment entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve randomization group data associated with enrollment entries from demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastEnrollment entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group data associated with enrollment entries of demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment({ID})/studySiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastEnrollment entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study site group data associated with enrollment entries of demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastEnrollment({ID})/treatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastEnrollment entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment group data associated with enrollment entries of demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Enrollment",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of demand forecast site group statuses.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast site group statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastSiteGroupStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of DemandForecastSiteGroupStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single demand forecast site group status.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast site group status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of DemandForecastSiteGroupStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a demand forecast site group status.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses",
|
|
"Demand Forecast Site Group Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized site group status description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of DemandForecastSiteGroupStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a demand forecast site group status.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses",
|
|
"Demand Forecast Site Group Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastSiteGroupStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of demand forecast site group statuses_texts.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast site group statuses_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastSiteGroupStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastSiteGroupStatuses_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code (business key) of DemandForecastSiteGroupStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single demand forecast site group statuses_text.",
|
|
"tags": [
|
|
"Demand Forecast Site Group Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast site group statuses_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits": {
|
|
"get": {
|
|
"summary": "Retrieve a list of demand forecast visits.",
|
|
"tags": [
|
|
"Demand Forecast Visits"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"visitPeriodID",
|
|
"visitPeriodID desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"visitPeriodID",
|
|
"demandForecast_ID",
|
|
"planningFigureDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup",
|
|
"treatmentPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast visits.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastVisits",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single demand forecast visit.",
|
|
"tags": [
|
|
"Demand Forecast Visits"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"visitPeriodID",
|
|
"demandForecast_ID",
|
|
"planningFigureDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup",
|
|
"treatmentPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast visit.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})/randomizationGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve randomization group infomration associated with visits in demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Visits",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group data associated with visits in demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Visits",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})/studySiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study site group data associated with visits in demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Visits",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})/treatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment group data associated with visits in demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Visits",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecastVisits({ID})/treatmentPeriod": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecastVisits entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment period data associated with visits in demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecast Visits",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecasts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of demand forecasts.",
|
|
"tags": [
|
|
"Demand Forecasts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"scenario_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollment",
|
|
"visits",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecasts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecasts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecasts({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecasts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single demand forecast.",
|
|
"tags": [
|
|
"Demand Forecasts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"scenario_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollment",
|
|
"visits",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecasts({ID})/demand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecasts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demands of a demand forecast.",
|
|
"tags": [
|
|
"Demand Forecasts",
|
|
"Demand Forecast Demand"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"depot",
|
|
"depot desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"visitPeriodID",
|
|
"visitPeriodID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc",
|
|
"depotDescription",
|
|
"depotDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"depot",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"visitPeriodID",
|
|
"kitType_ID",
|
|
"kitTypeID",
|
|
"kitTypeDescription",
|
|
"materialID",
|
|
"materialDescription",
|
|
"demandForecast_ID",
|
|
"planningFigureDescription",
|
|
"depotDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"mrpArea",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup",
|
|
"treatmentPeriod",
|
|
"kitType"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastDemand",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecasts({ID})/enrollment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecasts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of enrollment entries of a demand forecast.",
|
|
"tags": [
|
|
"Demand Forecasts",
|
|
"Demand Forecast Enrollment"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"depot",
|
|
"depot desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureDescription",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"depot",
|
|
"depotDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"demandForecast_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastEnrollment",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/DemandForecasts({ID})/visits": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of DemandForecasts entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of visits of a demand forecast.",
|
|
"tags": [
|
|
"Demand Forecasts",
|
|
"Demand Forecast Visits"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"planningFigureType",
|
|
"planningFigureType desc",
|
|
"planningFigureValue",
|
|
"planningFigureValue desc",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionNumerator desc",
|
|
"planningFigureFractionDenominator",
|
|
"planningFigureFractionDenominator desc",
|
|
"calendarWeek",
|
|
"calendarWeek desc",
|
|
"calendarWeekDate",
|
|
"calendarWeekDate desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc",
|
|
"visitPeriodID",
|
|
"visitPeriodID desc",
|
|
"demandForecast_ID",
|
|
"demandForecast_ID desc",
|
|
"planningFigureDescription",
|
|
"planningFigureDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"planningFigureType",
|
|
"planningFigureValue",
|
|
"planningFigureFractionNumerator",
|
|
"planningFigureFractionDenominator",
|
|
"calendarWeek",
|
|
"calendarWeekDate",
|
|
"scenarioSiteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroupID",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroupID",
|
|
"treatmentGroupDescription",
|
|
"visitPeriodID",
|
|
"demandForecast_ID",
|
|
"planningFigureDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studySiteGroup",
|
|
"scenarioSiteGroup",
|
|
"randomizationGroup",
|
|
"treatmentGroup",
|
|
"treatmentPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved visits.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of DemandForecastVisits",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves": {
|
|
"get": {
|
|
"summary": "Retrieve a list of enrollment curves.",
|
|
"tags": [
|
|
"Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"businessKey",
|
|
"businessKey desc",
|
|
"enrollmentCurveName",
|
|
"enrollmentCurveName desc",
|
|
"description",
|
|
"description desc",
|
|
"isObsolete",
|
|
"isObsolete desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"businessKey",
|
|
"enrollmentCurveName",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"dataPoints",
|
|
"connectedStudies",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curves.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of EnrollmentCurves",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of EnrollmentCurves entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single enrollment curve.",
|
|
"tags": [
|
|
"Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"businessKey",
|
|
"enrollmentCurveName",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"dataPoints",
|
|
"connectedStudies",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves({ID})/connectedStudies": {
|
|
"parameters": [
|
|
{
|
|
"description": " key: ID (UUID) of EnrollmentCurves entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of study data for studies that use a specific enrollment curve.",
|
|
"tags": [
|
|
"Enrollment Curves",
|
|
"Study Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"studyID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"scenarioSiteGroupID",
|
|
"scenarioSiteGroupID desc",
|
|
"treatmentGroupSiteGroupID",
|
|
"treatmentGroupSiteGroupID desc",
|
|
"enrollmentCurveID",
|
|
"enrollmentCurveID desc",
|
|
"studyBusinessKey",
|
|
"studyBusinessKey desc",
|
|
"studyDescription",
|
|
"studyDescription desc",
|
|
"scenarioBusinessKey",
|
|
"scenarioBusinessKey desc",
|
|
"scenarioDescription",
|
|
"scenarioDescription desc",
|
|
"scenarioStatusDescription",
|
|
"scenarioStatusDescription desc",
|
|
"scenarioStatusCode",
|
|
"scenarioStatusCode desc",
|
|
"siteGroupBusinessKey",
|
|
"siteGroupBusinessKey desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"randomizationGroupBusinessKey",
|
|
"randomizationGroupBusinessKey desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroupBusinessKey",
|
|
"treatmentGroupBusinessKey desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"scenarioSiteGroupID",
|
|
"treatmentGroupSiteGroupID",
|
|
"enrollmentCurveID",
|
|
"studyBusinessKey",
|
|
"studyDescription",
|
|
"scenarioBusinessKey",
|
|
"scenarioDescription",
|
|
"scenarioStatusDescription",
|
|
"scenarioStatusCode",
|
|
"siteGroupBusinessKey",
|
|
"siteGroupDescription",
|
|
"randomizationGroupBusinessKey",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroupBusinessKey",
|
|
"treatmentGroupDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved data associated with studies where curve is used.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyEnrollmentCurves",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves({ID})/dataPoints": {
|
|
"parameters": [
|
|
{
|
|
"description": " key: ID (UUID) of EnrollmentCurves entity ",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of data points of an enrollment curve.",
|
|
"tags": [
|
|
"Enrollment Curves",
|
|
"Enrollment Data Points"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"enrollmentPeriodPercentage",
|
|
"enrollmentPeriodPercentage desc",
|
|
"patientsEnrolledPercentage",
|
|
"patientsEnrolledPercentage desc",
|
|
"dataPoints_fc",
|
|
"dataPoints_fc desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"enrollmentPeriodPercentage",
|
|
"patientsEnrolledPercentage",
|
|
"dataPoints_fc",
|
|
"enrollmentCurve_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved data points.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of EnrollmentDataPoints",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves({ID})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of EnrollmentCurves entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of an enrollment curve.",
|
|
"tags": [
|
|
"Enrollment Curves",
|
|
"Enrollment Curves texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized enrollment curve description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves({ID})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of EnrollmentCurves entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of an enrollment curve.",
|
|
"tags": [
|
|
"Enrollment Curves",
|
|
"Enrollment Curves texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of EnrollmentCurves_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of enrollment curves_texts.",
|
|
"tags": [
|
|
"Enrollment Curves texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curves_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of EnrollmentCurves_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentCurves_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts (UUID).",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single enrollment curves_text.",
|
|
"tags": [
|
|
"Enrollment Curves texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curves_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentDataPoints": {
|
|
"get": {
|
|
"summary": "Retrieve a list of enrollment curve data points.",
|
|
"tags": [
|
|
"Enrollment Data Points"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"enrollmentPeriodPercentage",
|
|
"enrollmentPeriodPercentage desc",
|
|
"patientsEnrolledPercentage",
|
|
"patientsEnrolledPercentage desc",
|
|
"dataPoints_fc",
|
|
"dataPoints_fc desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"enrollmentPeriodPercentage",
|
|
"patientsEnrolledPercentage",
|
|
"dataPoints_fc",
|
|
"enrollmentCurve_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve data points.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of EnrollmentDataPoints",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentDataPoints({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of EnrollmentDataPoints entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single enrollment curve data point.",
|
|
"tags": [
|
|
"Enrollment Data Points"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"enrollmentPeriodPercentage",
|
|
"patientsEnrolledPercentage",
|
|
"dataPoints_fc",
|
|
"enrollmentCurve_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve data point.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/EnrollmentDataPoints({ID})/enrollmentCurve": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of EnrollmentDataPoints entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve enrollment curve data associated with enrollment curve data points.",
|
|
"tags": [
|
|
"Enrollment Data Points",
|
|
"Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"businessKey",
|
|
"enrollmentCurveName",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"dataPoints",
|
|
"connectedStudies",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ExternalEnrollmentTimeSeries": {
|
|
"get": {
|
|
"summary": "Retrieve a list of external enrollment entries.",
|
|
"tags": [
|
|
"External Enrollment Time Series"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"studyID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"enrollmentDate",
|
|
"enrollmentDate desc",
|
|
"enrollmentWeekDate",
|
|
"enrollmentWeekDate desc",
|
|
"enrollmentValue",
|
|
"enrollmentValue desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"randomizationGroupUUID",
|
|
"randomizationGroupUUID desc",
|
|
"studyUUID",
|
|
"studyUUID desc",
|
|
"scenarioUUID",
|
|
"scenarioUUID desc",
|
|
"treatmentGroupUUID",
|
|
"treatmentGroupUUID desc",
|
|
"siteGroupUUID",
|
|
"siteGroupUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"siteGroupID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"enrollmentDate",
|
|
"enrollmentWeekDate",
|
|
"enrollmentValue",
|
|
"protocolID",
|
|
"randomizationGroupUUID",
|
|
"studyUUID",
|
|
"scenarioUUID",
|
|
"treatmentGroupUUID",
|
|
"siteGroupUUID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external enrollment entries.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ExternalEnrollmentTimeSeries",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"summary": "Create a single external enrollment entry.",
|
|
"tags": [
|
|
"External Enrollment Time Series"
|
|
],
|
|
"requestBody": {
|
|
"description": "Provide one of: studyUUID, studyID, or protocolID.\nThe scenario-identifying data (scenarioUUID, scenarioID) can be omitted if there is an active scenario to which the data is to be pushed.\nProvide one of: siteGroupUUID or siteGroupID (e.g. US, FR).\nRandomization Group data (randomizationGroupUUID, randomizationGroupID) can be omitted if the study has exactly one randomization group.\nTreatment Group data (treatmentGroupUUID, treatmentGroupID) is optional. If not provided, enrollment is considered to be randomization group level.\nProvide one of enrollmentDate (UTC ISO date of Monday of the week) or enrollmentWeekDate (ISO week format).\nenrollmentValue (5 decimal places, e.g.123.12345) is mandatory.\nIf you provide more than one value to identify Study, Scenario, Randomization Group, Treatment group, or Enrollment (Week) Date, the first value in the stated order (e.g. studyUUID) is effective, the rest ignored.",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-create"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created external enrollment entry.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ExternalEnrollmentTimeSeries(studyID/studyUUID/protocolID='{studyID/studyUUID/protocolID}',scenarioID='{scenarioID}',siteGroupID='{siteGroupID}',randomizationGroupID='{randomizationGroupID}',treatmentGroupID='{treatmentGroupID}',enrollmentDate/enrollmentWeekDate={enrollmentDate/enrollmentWeekDate})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: studyID/studyUUID/protocolID",
|
|
"in": "query",
|
|
"name": "study ID or study UUID or protocol ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 36
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: scenarioID/scenarioUUID",
|
|
"in": "query",
|
|
"required": true,
|
|
"name": "scenario ID or scenario UUID",
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 36
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: siteGroupID",
|
|
"in": "query",
|
|
"name": "siteGroup ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: randomizationGroupID/randomizationGroupUUID",
|
|
"in": "query",
|
|
"required": true,
|
|
"name": "randomizationGroup ID or randomizationGroup UUID",
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 36
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatmentGroupID/treatmentGroupUUID",
|
|
"in": "query",
|
|
"required": true,
|
|
"name": "treatmentGroup ID or treatmentGroup UUID",
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 36
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: enrollmentDate/enrollmentWeekDate",
|
|
"in": "query",
|
|
"name": "enrollment Date or enrollment Week Date",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13/2017-W15"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single external enrollment entry.",
|
|
"tags": [
|
|
"External Enrollment Time Series"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"siteGroupID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"enrollmentDate",
|
|
"enrollmentWeekDate",
|
|
"enrollmentValue",
|
|
"protocolID",
|
|
"randomizationGroupUUID",
|
|
"studyUUID",
|
|
"scenarioUUID",
|
|
"treatmentGroupUUID",
|
|
"siteGroupUUID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external enrollment entry.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
},
|
|
"patch": {
|
|
"summary": "Change a single external enrollment entry.",
|
|
"tags": [
|
|
"External Enrollment Time Series"
|
|
],
|
|
"requestBody": {
|
|
"description": "Provide one of: studyUUID, studyID, or protocolID.\nThe scenario-identifying data (scenarioUUID, scenarioID) can be omitted if there is an active scenario to which the data is to be pushed.\nProvide one of: siteGroupUUID or siteGroupID (e.g. US, FR).\nRandomization Group data (randomizationGroupUUID, randomizationGroupID) can be omitted if the study has exactly one randomization group.\nTreatment Group data (treatmentGroupUUID, treatmentGroupID) is optional. If not provided, enrollment is considered to be randomization group level.\nProvide one of enrollmentDate (UTC ISO date of Monday of the week) or enrollmentWeekDate (ISO week format).\nenrollmentValue (5 decimal places, e.g.123.12345) is mandatory.\nIf you provide more than one value to identify Study, Scenario, Randomization Group, Treatment group, or Enrollment (Week) Date, the first value in the stated order (e.g. studyUUID) is effective, the rest ignored.",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-update"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
},
|
|
"delete": {
|
|
"summary": "Delete a single external enrollment entry.",
|
|
"description": "Provide one of studyUUID, studyID, or protocolID to identify the study.\nIf you provide more than one value, the first value in the stated order is effective, the rest ignored.",
|
|
"tags": [
|
|
"External Enrollment Time Series"
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ExternalIdentifiers": {
|
|
"get": {
|
|
"summary": "Retrieve a list of external identifiers.",
|
|
"tags": [
|
|
"External Identifiers"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"name",
|
|
"name desc",
|
|
"isVisible",
|
|
"isVisible desc",
|
|
"isObsolete",
|
|
"isObsolete desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"name",
|
|
"isVisible",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external identifiers.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ExternalIdentifiers",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/ExternalIdentifiers('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single external identifier.",
|
|
"tags": [
|
|
"External Identifiers"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"name",
|
|
"isVisible",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external identifier.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryLabelGroupElement": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type country label group records.",
|
|
"tags": [
|
|
"Kit Type Country Label Group Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"country_countryId",
|
|
"country_countryId desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"labelGroupID",
|
|
"labelGroupID desc",
|
|
"labelGroupDescription",
|
|
"labelGroupDescription desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"isActive",
|
|
"isActive desc",
|
|
"isPast",
|
|
"isPast desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"kitType_ID",
|
|
"kitTypeID",
|
|
"kitTypeDescription",
|
|
"country_countryId",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroup_ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"validFrom",
|
|
"isActive",
|
|
"isPast"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type country label group record.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeCountryLabelGroupElement",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryLabelGroupElement('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type country label group record.",
|
|
"tags": [
|
|
"Kit Type Country Label Group Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"kitType_ID",
|
|
"kitTypeID",
|
|
"kitTypeDescription",
|
|
"country_countryId",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroup_ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"validFrom",
|
|
"isActive",
|
|
"isPast"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type country label group record.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type country regulatory statuses.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeMaterialLabelGroupAssignment_ID",
|
|
"kitTypeMaterialLabelGroupAssignment_ID desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"countryID",
|
|
"countryID desc",
|
|
"regulatoryStatus_code",
|
|
"regulatoryStatus_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitTypeMaterialLabelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID",
|
|
"materialID",
|
|
"countryID",
|
|
"regulatoryStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"kitTypeMaterialLabelGroupAssignment",
|
|
"labelGroupAssignment",
|
|
"regulatoryStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type country regulatory statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeCountryRegulatoryStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitTypeMaterialLabelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID",
|
|
"materialID",
|
|
"countryID",
|
|
"regulatoryStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"kitTypeMaterialLabelGroupAssignment",
|
|
"labelGroupAssignment",
|
|
"regulatoryStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type country regulatory status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type data associated with a kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})/kitTypeMaterialLabelGroupAssignment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type material label group assignment of a kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses",
|
|
"Kit Type Material Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"material_ID",
|
|
"material_BK",
|
|
"labelGroupAssignment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"material",
|
|
"labelGroupAssignment",
|
|
"kitTypeCountryRegulatoryStatuses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type material label group assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})/labelGroupAssignment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve label group assignment of a kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses",
|
|
"Kit Type Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"position",
|
|
"labelGroup_ID",
|
|
"labelGroup_BK",
|
|
"kitType_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"labelGroup",
|
|
"kitType",
|
|
"labelMaterialAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})/regulatoryStatus": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve regulatory status of a kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses",
|
|
"Study Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved regulatory status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeCountryRegulatoryStatuses({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeCountryRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study data associated with a kit type country regulatory status.",
|
|
"tags": [
|
|
"Kit Type Country Regulatory Statuses",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeLabelGroupAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type label group assignments.",
|
|
"tags": [
|
|
"Kit Type Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"position",
|
|
"position desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"labelGroup_BK",
|
|
"labelGroup_BK desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"position",
|
|
"labelGroup_ID",
|
|
"labelGroup_BK",
|
|
"kitType_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"labelGroup",
|
|
"kitType",
|
|
"labelMaterialAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type label group assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeLabelGroupAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeLabelGroupAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type label group assignment.",
|
|
"tags": [
|
|
"Kit Type Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"position",
|
|
"labelGroup_ID",
|
|
"labelGroup_BK",
|
|
"kitType_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"labelGroup",
|
|
"kitType",
|
|
"labelMaterialAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type label group assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeLabelGroupAssignments({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a kit type label group assignment.",
|
|
"tags": [
|
|
"Kit Type Label Group Assignments",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeLabelGroupAssignments({ID})/labelGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve label group data associated with a kit type label group assignment.",
|
|
"tags": [
|
|
"Kit Type Label Group Assignments",
|
|
"Label Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroupCountryAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeLabelGroupAssignments({ID})/labelMaterialAssignments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of label material assignments of a kit type label group assignment.",
|
|
"tags": [
|
|
"Kit Type Label Group Assignments",
|
|
"Kit Type Material Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"material_BK",
|
|
"material_BK desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"material_ID",
|
|
"material_BK",
|
|
"labelGroupAssignment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"material",
|
|
"labelGroupAssignment",
|
|
"kitTypeCountryRegulatoryStatuses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label material assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeMaterialLabelGroupAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type material label group assignments.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"material_BK",
|
|
"material_BK desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"material_ID",
|
|
"material_BK",
|
|
"labelGroupAssignment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"material",
|
|
"labelGroupAssignment",
|
|
"kitTypeCountryRegulatoryStatuses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type material label group assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeMaterialLabelGroupAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"material_ID",
|
|
"material_BK",
|
|
"labelGroupAssignment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"material",
|
|
"labelGroupAssignment",
|
|
"kitTypeCountryRegulatoryStatuses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type material label group assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})/kitTypeCountryRegulatoryStatuses": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type country regulatory statuses of a kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments",
|
|
"Kit Type Country Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeMaterialLabelGroupAssignment_ID",
|
|
"kitTypeMaterialLabelGroupAssignment_ID desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"countryID",
|
|
"countryID desc",
|
|
"regulatoryStatus_code",
|
|
"regulatoryStatus_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitTypeMaterialLabelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID",
|
|
"materialID",
|
|
"countryID",
|
|
"regulatoryStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"kitTypeMaterialLabelGroupAssignment",
|
|
"labelGroupAssignment",
|
|
"regulatoryStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type country regulatory statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeCountryRegulatoryStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})/labelGroupAssignment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve label group assignment of a kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments",
|
|
"Kit Type Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"position",
|
|
"labelGroup_ID",
|
|
"labelGroup_BK",
|
|
"kitType_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"labelGroup",
|
|
"kitType",
|
|
"labelMaterialAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})/material": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve material of a kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments",
|
|
"Study Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"comment",
|
|
"material_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"material",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMaterialLabelGroupAssignments({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMaterialLabelGroupAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a kit type material label group assignment.",
|
|
"tags": [
|
|
"Kit Type Material Label Group Assignments",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMolecules": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type molecules.",
|
|
"tags": [
|
|
"Kit Type Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"molecule_MoleculeUUID",
|
|
"molecule_MoleculeUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitType_ID",
|
|
"molecule_MoleculeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitType",
|
|
"molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type molecules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeMolecules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMolecules({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMolecules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type molecule.",
|
|
"tags": [
|
|
"Kit Type Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitType_ID",
|
|
"molecule_MoleculeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitType",
|
|
"molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMolecules({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMolecules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a kit type molecule.",
|
|
"tags": [
|
|
"Kit Type Molecules",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeMolecules({ID})/molecule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeMolecules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve molecule of a kit type molecule.",
|
|
"tags": [
|
|
"Kit Type Molecules",
|
|
"Cached Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"MoleculeUUID",
|
|
"MoleculeId",
|
|
"Description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type site group depots.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"depotBuffer",
|
|
"depotBuffer desc",
|
|
"shipLeadTime",
|
|
"shipLeadTime desc",
|
|
"siteBuffer",
|
|
"siteBuffer desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"country_countryId",
|
|
"country_countryId desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"centralDepot_ID",
|
|
"centralDepot_ID desc",
|
|
"distrDepot_ID",
|
|
"distrDepot_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"country_countryId",
|
|
"siteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"country",
|
|
"siteGroup",
|
|
"studySiteGroup",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type site group depots.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeSiteGroupDepots",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"country_countryId",
|
|
"siteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"country",
|
|
"siteGroup",
|
|
"studySiteGroup",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type site group depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/centralDepot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve central depot of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved central depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/country": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve country of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Country"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"countryId",
|
|
"countryName",
|
|
"daysOffset"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/distrDepot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve distr depot of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved distr depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/siteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve site group of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeSiteGroupDepots({ID})/studySiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeSiteGroupDepots entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study site group of a kit type site group depot.",
|
|
"tags": [
|
|
"Kit Type Site Group Depots",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreatmentAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type treatment assignments.",
|
|
"tags": [
|
|
"Kit Type Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"quantity",
|
|
"quantity desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"validTo",
|
|
"validTo desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitType_BK",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type treatment assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeTreatmentAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreatmentAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type treatment assignment.",
|
|
"tags": [
|
|
"Kit Type Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitType_BK",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type treatment assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreatmentAssignments({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a kit type treatment assignment.",
|
|
"tags": [
|
|
"Kit Type Treatment Assignments",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreatmentAssignments({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a kit type treatment assignment.",
|
|
"tags": [
|
|
"Kit Type Treatment Assignments",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreatmentAssignments({ID})/treatment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypeTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment of a kit type treatment assignment.",
|
|
"tags": [
|
|
"Kit Type Treatment Assignments",
|
|
"Study Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentID",
|
|
"description",
|
|
"scenario_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"study",
|
|
"kitTypeAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreeElement": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type tree records.",
|
|
"tags": [
|
|
"Kit Type Tree Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"nodeID",
|
|
"nodeID desc",
|
|
"hierarchyLevel",
|
|
"hierarchyLevel desc",
|
|
"description",
|
|
"description desc",
|
|
"external_UUID",
|
|
"external_UUID desc",
|
|
"externalDescription",
|
|
"externalDescription desc",
|
|
"parentNodeID",
|
|
"parentNodeID desc",
|
|
"drillState",
|
|
"drillState desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_ID desc",
|
|
"blindingGroupDescription",
|
|
"blindingGroupDescription desc",
|
|
"distributingTemplate_ID",
|
|
"distributingTemplate_ID desc",
|
|
"distributingTemplateDescription",
|
|
"distributingTemplateDescription desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"kitTypeID_INT",
|
|
"kitTypeID_INT desc",
|
|
"businessID_INT",
|
|
"businessID_INT desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"countryID",
|
|
"countryID desc",
|
|
"countryAssignment_ID",
|
|
"countryAssignment_ID desc",
|
|
"adminType",
|
|
"adminType desc",
|
|
"siteAdminPeriod",
|
|
"siteAdminPeriod desc",
|
|
"serialization",
|
|
"serialization desc",
|
|
"kitTypePosition",
|
|
"kitTypePosition desc",
|
|
"labelGroupPosition",
|
|
"labelGroupPosition desc",
|
|
"HasActiveEntity",
|
|
"HasActiveEntity desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"nodeID",
|
|
"hierarchyLevel",
|
|
"description",
|
|
"external_UUID",
|
|
"externalDescription",
|
|
"parentNodeID",
|
|
"drillState",
|
|
"kitTypeID",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroupDescription",
|
|
"distributingTemplate_ID",
|
|
"distributingTemplateDescription",
|
|
"materialDescription",
|
|
"kitTypeID_INT",
|
|
"businessID_INT",
|
|
"labelGroup_ID",
|
|
"countryID",
|
|
"countryAssignment_ID",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"kitTypePosition",
|
|
"labelGroupPosition",
|
|
"HasActiveEntity"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type tree records.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeTreeElement",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypeTreeElement('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type tree record.",
|
|
"tags": [
|
|
"Kit Type Tree Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"nodeID",
|
|
"hierarchyLevel",
|
|
"description",
|
|
"external_UUID",
|
|
"externalDescription",
|
|
"parentNodeID",
|
|
"drillState",
|
|
"kitTypeID",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroupDescription",
|
|
"distributingTemplate_ID",
|
|
"distributingTemplateDescription",
|
|
"materialDescription",
|
|
"kitTypeID_INT",
|
|
"businessID_INT",
|
|
"labelGroup_ID",
|
|
"countryID",
|
|
"countryAssignment_ID",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"kitTypePosition",
|
|
"labelGroupPosition",
|
|
"HasActiveEntity"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type tree record.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes": {
|
|
"get": {
|
|
"summary": "Retrieve a list of kit types.",
|
|
"tags": [
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"description",
|
|
"description desc",
|
|
"position",
|
|
"position desc",
|
|
"adminType",
|
|
"adminType desc",
|
|
"siteAdminPeriod",
|
|
"siteAdminPeriod desc",
|
|
"serialization",
|
|
"serialization desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_ID desc",
|
|
"blindingGroup_BK",
|
|
"blindingGroup_BK desc",
|
|
"distrTemplateId_ID",
|
|
"distrTemplateId_ID desc",
|
|
"refKitType_RefKitTypeUUID",
|
|
"refKitType_RefKitTypeUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypes",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single kit type.",
|
|
"tags": [
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/blindingGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve blinding group of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Blinding Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingGroupID",
|
|
"blindingGroupDescription",
|
|
"blindedDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/countryLabelGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of country label groups of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Kit Type Country Label Group Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"country_countryId",
|
|
"country_countryId desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"labelGroupID",
|
|
"labelGroupID desc",
|
|
"labelGroupDescription",
|
|
"labelGroupDescription desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"isActive",
|
|
"isActive desc",
|
|
"isPast",
|
|
"isPast desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"kitType_ID",
|
|
"kitTypeID",
|
|
"kitTypeDescription",
|
|
"country_countryId",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroup_ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"validFrom",
|
|
"isActive",
|
|
"isPast"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country label groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeCountryLabelGroupElement",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/countryMaterials": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of country materials of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Kit Type Material Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"material_BK",
|
|
"material_BK desc",
|
|
"labelGroupAssignment_ID",
|
|
"labelGroupAssignment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"material_ID",
|
|
"material_BK",
|
|
"labelGroupAssignment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"material",
|
|
"labelGroupAssignment",
|
|
"kitTypeCountryRegulatoryStatuses"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country materials.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeMaterialLabelGroupAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/countrySiteGroupDepots": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of country site group depots of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Kit Type Site Group Depots"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"depotBuffer",
|
|
"depotBuffer desc",
|
|
"shipLeadTime",
|
|
"shipLeadTime desc",
|
|
"siteBuffer",
|
|
"siteBuffer desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"country_countryId",
|
|
"country_countryId desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"centralDepot_ID",
|
|
"centralDepot_ID desc",
|
|
"distrDepot_ID",
|
|
"distrDepot_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"country_countryId",
|
|
"siteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"country",
|
|
"siteGroup",
|
|
"studySiteGroup",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country site group depots.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeSiteGroupDepots",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/distrTemplateId": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve distr template id of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Cached Distributing Templates"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved distr template id.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/kitTypeMolecules": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type molecules of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Kit Type Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"molecule_MoleculeUUID",
|
|
"molecule_MoleculeUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitType_ID",
|
|
"molecule_MoleculeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitType",
|
|
"molecule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type molecules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeMolecules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/labelGroupAssignments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of label group assignments of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Kit Type Label Group Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"position",
|
|
"position desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"labelGroup_BK",
|
|
"labelGroup_BK desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"position",
|
|
"labelGroup_ID",
|
|
"labelGroup_BK",
|
|
"kitType_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"labelGroup",
|
|
"kitType",
|
|
"labelMaterialAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeLabelGroupAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/refKitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve reference kit type of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Cached Ref Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"RefKitTypeUUID",
|
|
"RefKitID",
|
|
"INNDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"KitTypeItems"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved reference kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/KitTypes({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of KitTypes entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a kit type.",
|
|
"tags": [
|
|
"Kit Types",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroupCountryAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of label group country assignments.",
|
|
"tags": [
|
|
"Label Group Country Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"country_countryId",
|
|
"country_countryId desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"labelGroup_ID",
|
|
"country_countryId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroup",
|
|
"country"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group country assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LabelGroupCountryAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroupCountryAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroupCountryAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single label group country assignment.",
|
|
"tags": [
|
|
"Label Group Country Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"labelGroup_ID",
|
|
"country_countryId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroup",
|
|
"country"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group country assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroupCountryAssignments({ID})/country": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroupCountryAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve country of a label group country assignment.",
|
|
"tags": [
|
|
"Label Group Country Assignments",
|
|
"Country"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"countryId",
|
|
"countryName",
|
|
"daysOffset"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved country.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroupCountryAssignments({ID})/labelGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroupCountryAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve label group of a label group country assignment.",
|
|
"tags": [
|
|
"Label Group Country Assignments",
|
|
"Label Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroupCountryAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroupCountryAssignments({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroupCountryAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a label group country assignment.",
|
|
"tags": [
|
|
"Label Group Country Assignments",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of label groups.",
|
|
"tags": [
|
|
"Label Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"labelGroupID",
|
|
"labelGroupID desc",
|
|
"labelGroupDescription",
|
|
"labelGroupDescription desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroupCountryAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LabelGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single label group.",
|
|
"tags": [
|
|
"Label Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroupCountryAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroups({ID})/labelGroupCountryAssignments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of label group country assignments of a label group.",
|
|
"tags": [
|
|
"Label Groups",
|
|
"Label Group Country Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"country_countryId",
|
|
"country_countryId desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"validFrom",
|
|
"study_ID",
|
|
"labelGroup_ID",
|
|
"country_countryId"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroup",
|
|
"country"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label group country assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LabelGroupCountryAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LabelGroups({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LabelGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a label group.",
|
|
"tags": [
|
|
"Label Groups",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lead molecules.",
|
|
"tags": [
|
|
"Lead Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"sort_num",
|
|
"sort_num desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc",
|
|
"isObsolete",
|
|
"isObsolete desc",
|
|
"externalID",
|
|
"externalID desc",
|
|
"sourceSystem",
|
|
"sourceSystem desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete",
|
|
"externalID",
|
|
"sourceSystem"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lead molecules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeadMolecules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lead molecule.",
|
|
"tags": [
|
|
"Lead Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete",
|
|
"externalID",
|
|
"sourceSystem"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lead molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a lead molecule.",
|
|
"tags": [
|
|
"Lead Molecules",
|
|
"Lead Molecules texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized lead molecule description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a lead molecule.",
|
|
"tags": [
|
|
"Lead Molecules",
|
|
"Lead Molecules texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeadMolecules_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lead molecules_texts.",
|
|
"tags": [
|
|
"Lead Molecules texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lead molecules_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeadMolecules_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeadMolecules_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts.",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lead molecules_text.",
|
|
"tags": [
|
|
"Lead Molecules texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lead molecules_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study demand bucket values.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"depotID",
|
|
"depotID desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"leanStudyDemandUUID",
|
|
"leanStudyDemandUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription",
|
|
"leanStudyDemandUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demand bucket values.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandBucketValues",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription",
|
|
"leanStudyDemandUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demand bucket value.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/depot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve depot of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/kittype": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kittype of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kittype.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/material": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve material of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/protocol": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve protocol of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved protocol.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/siteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve site group of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBucketValues({ID})/studyDemand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandBucketValues entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study demand of a lean study demand bucket value.",
|
|
"tags": [
|
|
"Lean Study Demand Bucket Values",
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBuckets": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study demand buckets.",
|
|
"tags": [
|
|
"Lean Study Demand Buckets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyDemandUUID",
|
|
"studyDemandUUID desc",
|
|
"dateValue",
|
|
"dateValue desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyDemandUUID",
|
|
"dateValue"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demand buckets.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandBuckets",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandBuckets(studyDemandUUID={studyDemandUUID},dateValue={dateValue})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: studyDemandUUID",
|
|
"in": "path",
|
|
"name": "studyDemandUUID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: dateValue",
|
|
"in": "path",
|
|
"name": "dateValue",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study demand bucket.",
|
|
"tags": [
|
|
"Lean Study Demand Buckets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyDemandUUID",
|
|
"dateValue"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demand bucket.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study demands.",
|
|
"tags": [
|
|
"Lean Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"protocol_BK",
|
|
"protocol_BK desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"kittype_BK",
|
|
"kittype_BK desc",
|
|
"material_ID",
|
|
"material_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"protocol_BK",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"kittype_BK",
|
|
"material_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demands.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemands",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"protocol_BK",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"kittype_BK",
|
|
"material_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/depot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve depot of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/kittype": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kittype of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kittype.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/material": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve material of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/protocol": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve protocol of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved protocol.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/siteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve site group of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemands({ID})/studyDemand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study demand of a lean study demand.",
|
|
"tags": [
|
|
"Lean Study Demands",
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study demands presentations.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"dummy",
|
|
"dummy desc",
|
|
"dummyExpands",
|
|
"dummyExpands desc",
|
|
"leanStudyDemandUUID",
|
|
"leanStudyDemandUUID desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"depotID",
|
|
"depotID desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"dummy",
|
|
"dummyExpands",
|
|
"leanStudyDemandUUID",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material",
|
|
"bucketValues"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demands presentation.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandsPresentation",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"dummy",
|
|
"dummyExpands",
|
|
"leanStudyDemandUUID",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material",
|
|
"bucketValues"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study demands presentation.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/bucketValues": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of bucket values of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Lean Study Demand Bucket Values"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"depotID",
|
|
"depotID desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"leanStudyDemandUUID",
|
|
"leanStudyDemandUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription",
|
|
"leanStudyDemandUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved bucket values.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandBucketValues",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/depot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve depot of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/kittype": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kittype of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kittype.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/material": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve material of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/protocol": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve protocol of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved protocol.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/siteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve site group of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyDemandsPresentation({ID})/studyDemand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudyDemandsPresentation entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study demand of a lean study demands presentation.",
|
|
"tags": [
|
|
"Lean Study Demands Presentation",
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study schedule agreement statuses.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study schedule agreement statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyScheduleAgreementStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of LeanStudyScheduleAgreementStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study schedule agreement status.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study schedule agreement status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of LeanStudyScheduleAgreementStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a lean study schedule agreement status.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses",
|
|
"Lean Study Schedule Agreement Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized status description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of LeanStudyScheduleAgreementStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a lean study schedule agreement status.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses",
|
|
"Lean Study Schedule Agreement Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyScheduleAgreementStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study schedule agreement statuses_texts.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study schedule agreement statuses_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyScheduleAgreementStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudyScheduleAgreementStatuses_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study schedule agreement statuses_text.",
|
|
"tags": [
|
|
"Lean Study Schedule Agreement Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study schedule agreement statuses_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of lean study site groups.",
|
|
"tags": [
|
|
"Lean Study Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"demand_ID",
|
|
"demand_ID desc",
|
|
"pushedOn",
|
|
"pushedOn desc",
|
|
"pushedBy",
|
|
"pushedBy desc",
|
|
"pushStatus",
|
|
"pushStatus desc",
|
|
"interimStatus",
|
|
"interimStatus desc",
|
|
"pushedScheAgrCount",
|
|
"pushedScheAgrCount desc",
|
|
"pushEpoch",
|
|
"pushEpoch desc",
|
|
"successPushOn",
|
|
"successPushOn desc",
|
|
"successPushBy",
|
|
"successPushBy desc",
|
|
"documentNumber",
|
|
"documentNumber desc",
|
|
"documentStatus",
|
|
"documentStatus desc",
|
|
"isKitTypeSpecific",
|
|
"isKitTypeSpecific desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"kitTypeSiteGroup_ID",
|
|
"kitTypeSiteGroup_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"isActive",
|
|
"isActive desc",
|
|
"protocolIDLabel",
|
|
"protocolIDLabel desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"demand_ID",
|
|
"pushedOn",
|
|
"pushedBy",
|
|
"pushStatus",
|
|
"interimStatus",
|
|
"pushedScheAgrCount",
|
|
"pushEpoch",
|
|
"successPushOn",
|
|
"successPushBy",
|
|
"documentNumber",
|
|
"documentStatus",
|
|
"isKitTypeSpecific",
|
|
"studySiteGroup_ID",
|
|
"kitTypeSiteGroup_ID",
|
|
"protocol_ID",
|
|
"isActive",
|
|
"protocolIDLabel"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"demand",
|
|
"pushStatusDescription",
|
|
"documentStatusDescription",
|
|
"logEntries",
|
|
"studySiteGroup",
|
|
"kitTypeSiteGroup",
|
|
"protocol"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudySiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"demand_ID",
|
|
"pushedOn",
|
|
"pushedBy",
|
|
"pushStatus",
|
|
"interimStatus",
|
|
"pushedScheAgrCount",
|
|
"pushEpoch",
|
|
"successPushOn",
|
|
"successPushBy",
|
|
"documentNumber",
|
|
"documentStatus",
|
|
"isKitTypeSpecific",
|
|
"studySiteGroup_ID",
|
|
"kitTypeSiteGroup_ID",
|
|
"protocol_ID",
|
|
"isActive",
|
|
"protocolIDLabel"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"demand",
|
|
"pushStatusDescription",
|
|
"documentStatusDescription",
|
|
"logEntries",
|
|
"studySiteGroup",
|
|
"kitTypeSiteGroup",
|
|
"protocol"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lean study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/demand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve demand of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/documentStatusDescription": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve document status description of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Lean Study Schedule Agreement Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved document status description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/kitTypeSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type site group of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Kit Type Site Group Depots"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"country_countryId",
|
|
"siteGroup_ID",
|
|
"studySiteGroup_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"country",
|
|
"siteGroup",
|
|
"studySiteGroup",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/logEntries": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of log entries of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Push To S P Log Entries"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"messageType",
|
|
"messageType desc",
|
|
"code",
|
|
"code desc",
|
|
"message",
|
|
"message desc",
|
|
"variable1",
|
|
"variable1 desc",
|
|
"variable2",
|
|
"variable2 desc",
|
|
"variable3",
|
|
"variable3 desc",
|
|
"variable4",
|
|
"variable4 desc",
|
|
"entryOrder",
|
|
"entryOrder desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"messageType",
|
|
"code",
|
|
"message",
|
|
"variable1",
|
|
"variable2",
|
|
"variable3",
|
|
"variable4",
|
|
"entryOrder",
|
|
"siteGroupID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved log entries.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of PushToSPLogEntries",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/protocol": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve protocol of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved protocol.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/pushStatusDescription": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve push status description of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Demand Forecast Site Group Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved push status description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/LeanStudySiteGroups({ID})/studySiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of LeanStudySiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study site group of a lean study site group.",
|
|
"tags": [
|
|
"Lean Study Site Groups",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Materials": {
|
|
"get": {
|
|
"summary": "Retrieve a list of materials.",
|
|
"tags": [
|
|
"Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"baseUnit",
|
|
"baseUnit desc",
|
|
"numberOfDecimals",
|
|
"numberOfDecimals desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved materials.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Materials",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Materials"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Materials('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single material.",
|
|
"tags": [
|
|
"Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Materials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/MaterialsView": {
|
|
"get": {
|
|
"summary": "Retrieve a list of materials views.",
|
|
"tags": [
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"baseUnit",
|
|
"baseUnit desc",
|
|
"numberOfDecimals",
|
|
"numberOfDecimals desc",
|
|
"description",
|
|
"description desc",
|
|
"crossStudy",
|
|
"crossStudy desc",
|
|
"category",
|
|
"category desc",
|
|
"materialTypeName",
|
|
"materialTypeName desc",
|
|
"source",
|
|
"source desc",
|
|
"status",
|
|
"status desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved materials view.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of MaterialsView",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/MaterialsView('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single materials view.",
|
|
"tags": [
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved materials view.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Persons": {
|
|
"get": {
|
|
"summary": "Retrieve a list of persons.",
|
|
"tags": [
|
|
"Persons"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"personNumber",
|
|
"personNumber desc",
|
|
"userSource",
|
|
"userSource desc",
|
|
"firstName",
|
|
"firstName desc",
|
|
"lastName",
|
|
"lastName desc",
|
|
"email",
|
|
"email desc",
|
|
"phoneNumber",
|
|
"phoneNumber desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"personNumber",
|
|
"userSource",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved persons.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Persons",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Persons(personNumber='{personNumber}',userSource={userSource})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: personNumber",
|
|
"in": "path",
|
|
"name": "personNumber",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: userSource",
|
|
"in": "path",
|
|
"name": "userSource",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single person.",
|
|
"tags": [
|
|
"Persons"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"personNumber",
|
|
"userSource",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved person.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/PushToSPLogEntries": {
|
|
"get": {
|
|
"summary": "Retrieve a list of push to supply planning log entries.",
|
|
"tags": [
|
|
"Push To S P Log Entries"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"messageType",
|
|
"messageType desc",
|
|
"code",
|
|
"code desc",
|
|
"message",
|
|
"message desc",
|
|
"variable1",
|
|
"variable1 desc",
|
|
"variable2",
|
|
"variable2 desc",
|
|
"variable3",
|
|
"variable3 desc",
|
|
"variable4",
|
|
"variable4 desc",
|
|
"entryOrder",
|
|
"entryOrder desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"messageType",
|
|
"code",
|
|
"message",
|
|
"variable1",
|
|
"variable2",
|
|
"variable3",
|
|
"variable4",
|
|
"entryOrder",
|
|
"siteGroupID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved push to supply planning log entries.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of PushToSPLogEntries",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/PushToSPLogEntries({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of PushToSPLogEntries entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single push to supply planning log entry.",
|
|
"tags": [
|
|
"Push To S P Log Entries"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"messageType",
|
|
"code",
|
|
"message",
|
|
"variable1",
|
|
"variable2",
|
|
"variable3",
|
|
"variable4",
|
|
"entryOrder",
|
|
"siteGroupID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved push to supply planning log entry.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of randomization group site groups.",
|
|
"tags": [
|
|
"Randomization Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"randomizationGroupId",
|
|
"randomizationGroupId desc",
|
|
"recalculatedLSFV",
|
|
"recalculatedLSFV desc",
|
|
"participatesInCompetitiveEnrollment",
|
|
"participatesInCompetitiveEnrollment desc",
|
|
"competitiveEnrollment",
|
|
"competitiveEnrollment desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc",
|
|
"enrollmentCurve_BK",
|
|
"enrollmentCurve_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"recalculationMethod_code",
|
|
"recalculationMethod_code desc",
|
|
"enrollmentRecalculationMethodFallbackUsed_code",
|
|
"enrollmentRecalculationMethodFallbackUsed_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"randomizationGroupId",
|
|
"recalculatedLSFV",
|
|
"participatesInCompetitiveEnrollment",
|
|
"competitiveEnrollment",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_BK",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID",
|
|
"scenarioSiteGroup_ID",
|
|
"recalculationMethod_code",
|
|
"enrollmentRecalculationMethodFallbackUsed_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"scenarioSiteGroup",
|
|
"recalculationMethod",
|
|
"enrollmentRecalculationMethodFallbackUsed"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RandomizationGroupSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"randomizationGroupId",
|
|
"recalculatedLSFV",
|
|
"participatesInCompetitiveEnrollment",
|
|
"competitiveEnrollment",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_BK",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID",
|
|
"scenarioSiteGroup_ID",
|
|
"recalculationMethod_code",
|
|
"enrollmentRecalculationMethodFallbackUsed_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"scenarioSiteGroup",
|
|
"recalculationMethod",
|
|
"enrollmentRecalculationMethodFallbackUsed"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/enrollmentCurve": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve enrollment curve of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"businessKey",
|
|
"enrollmentCurveName",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"dataPoints",
|
|
"connectedStudies",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/enrollmentRecalculationMethodFallbackUsed": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve enrollment recalculation method fallback used of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Recalculation Method Fallback Used"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment recalculation method fallback used.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/randomizationGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve randomization group of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/recalculationMethod": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve recalculation method of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Recalculation Method"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroupSiteGroups({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group of a randomization group site group.",
|
|
"tags": [
|
|
"Randomization Group Site Groups",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of randomization groups.",
|
|
"tags": [
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"position",
|
|
"position desc",
|
|
"description",
|
|
"description desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"ratioMode_code",
|
|
"ratioMode_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RandomizationGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single randomization group.",
|
|
"tags": [
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})/randomizationGroupSiteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of randomization group site groups of a randomization group.",
|
|
"tags": [
|
|
"Randomization Groups",
|
|
"Randomization Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"randomizationGroupId",
|
|
"randomizationGroupId desc",
|
|
"recalculatedLSFV",
|
|
"recalculatedLSFV desc",
|
|
"participatesInCompetitiveEnrollment",
|
|
"participatesInCompetitiveEnrollment desc",
|
|
"competitiveEnrollment",
|
|
"competitiveEnrollment desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc",
|
|
"enrollmentCurve_BK",
|
|
"enrollmentCurve_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc",
|
|
"recalculationMethod_code",
|
|
"recalculationMethod_code desc",
|
|
"enrollmentRecalculationMethodFallbackUsed_code",
|
|
"enrollmentRecalculationMethodFallbackUsed_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"randomizationGroupId",
|
|
"recalculatedLSFV",
|
|
"participatesInCompetitiveEnrollment",
|
|
"competitiveEnrollment",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_BK",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID",
|
|
"scenarioSiteGroup_ID",
|
|
"recalculationMethod_code",
|
|
"enrollmentRecalculationMethodFallbackUsed_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"scenarioSiteGroup",
|
|
"recalculationMethod",
|
|
"enrollmentRecalculationMethodFallbackUsed"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RandomizationGroupSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})/ratioMode": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve ratio mode of a randomization group.",
|
|
"tags": [
|
|
"Randomization Groups",
|
|
"Ratio Mode"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved ratio mode.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a randomization group.",
|
|
"tags": [
|
|
"Randomization Groups",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})/treatmentGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment groups of a randomization group.",
|
|
"tags": [
|
|
"Randomization Groups",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"studyTreatmentGroupID",
|
|
"studyTreatmentGroupID desc",
|
|
"offset",
|
|
"offset desc",
|
|
"offsetUnit",
|
|
"offsetUnit desc",
|
|
"position",
|
|
"position desc",
|
|
"description",
|
|
"description desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"ratioPercent",
|
|
"ratioPercent desc",
|
|
"ratioAbsolute",
|
|
"ratioAbsolute desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RandomizationGroups({ID})/treatmentSchedule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of RandomizationGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment schedules of a randomization group.",
|
|
"tags": [
|
|
"Randomization Groups",
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSchedules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode": {
|
|
"get": {
|
|
"summary": "Retrieve a list of ratio modes.",
|
|
"tags": [
|
|
"Ratio Mode"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved ratio mode.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RatioMode",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RatioMode entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single ratio mode.",
|
|
"tags": [
|
|
"Ratio Mode"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved ratio mode.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RatioMode entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a ratio mode.",
|
|
"tags": [
|
|
"Ratio Mode",
|
|
"Ratio Mode texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RatioMode entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a ratio mode.",
|
|
"tags": [
|
|
"Ratio Mode",
|
|
"Ratio Mode texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RatioMode_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of ratio mode_texts.",
|
|
"tags": [
|
|
"Ratio Mode texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved ratio mode_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RatioMode_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RatioMode_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single ratio mode_text.",
|
|
"tags": [
|
|
"Ratio Mode texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved ratio mode_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod": {
|
|
"get": {
|
|
"summary": "Retrieve a list of recalculation methods.",
|
|
"tags": [
|
|
"Recalculation Method"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethod",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethod entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single recalculation method.",
|
|
"tags": [
|
|
"Recalculation Method"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethod entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized descripton of a recalculation method.",
|
|
"tags": [
|
|
"Recalculation Method",
|
|
"Recalculation Method texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethod entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a recalculation method.",
|
|
"tags": [
|
|
"Recalculation Method",
|
|
"Recalculation Method texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethod_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed": {
|
|
"get": {
|
|
"summary": "Retrieve a list of recalculation method fallbacks used.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method fallback used.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethodFallbackUsed",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethodFallbackUsed entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single recalculation method fallback used.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method fallback used.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethodFallbackUsed entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a recalculation method fallback used.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used",
|
|
"Recalculation Method Fallback Used texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of RecalculationMethodFallbackUsed entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a recalculation method fallback used.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used",
|
|
"Recalculation Method Fallback Used texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethodFallbackUsed_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of recalculation method fallback used_texts.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method fallback used_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethodFallbackUsed_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethodFallbackUsed_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single recalculation method fallback used_text.",
|
|
"tags": [
|
|
"Recalculation Method Fallback Used texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method fallback used_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of recalculation method_texts.",
|
|
"tags": [
|
|
"Recalculation Method texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RecalculationMethod_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/RecalculationMethod_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single recalculation method_text.",
|
|
"tags": [
|
|
"Recalculation Method texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved recalculation method_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios": {
|
|
"get": {
|
|
"summary": "Retrieve a list of scenarios.",
|
|
"tags": [
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"scenario_num",
|
|
"scenario_num desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"description",
|
|
"description desc",
|
|
"detailedDescription",
|
|
"detailedDescription desc",
|
|
"statusChangedAt",
|
|
"statusChangedAt desc",
|
|
"ctmProtocolUpdate",
|
|
"ctmProtocolUpdate desc",
|
|
"copiedFrom",
|
|
"copiedFrom desc",
|
|
"hasECManualToAutoChange",
|
|
"hasECManualToAutoChange desc",
|
|
"status_code",
|
|
"status_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenarios.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Scenarios",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single scenario.",
|
|
"tags": [
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/consolidatedSiteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of consolidated site groups of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Consolidated Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"lastSubjectLastVisit",
|
|
"lastSubjectLastVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"activatedSites",
|
|
"activatedSites desc",
|
|
"isLinkedCTMS",
|
|
"isLinkedCTMS desc",
|
|
"isStudyCompleted",
|
|
"isStudyCompleted desc",
|
|
"ctmsPlannedEnrollment",
|
|
"ctmsPlannedEnrollment desc",
|
|
"ctmsFirstSubjectFirstVisit",
|
|
"ctmsFirstSubjectFirstVisit desc",
|
|
"ctmsLastSubjectFirstVisit",
|
|
"ctmsLastSubjectFirstVisit desc",
|
|
"ctmsPlannedSites",
|
|
"ctmsPlannedSites desc",
|
|
"ctmsActualSites",
|
|
"ctmsActualSites desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"active",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"scenario_ID",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"isLinkedCTMS",
|
|
"isStudyCompleted",
|
|
"ctmsPlannedEnrollment",
|
|
"ctmsFirstSubjectFirstVisit",
|
|
"ctmsLastSubjectFirstVisit",
|
|
"ctmsPlannedSites",
|
|
"ctmsActualSites"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved consolidated site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ConsolidatedSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/demandForecast": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve demand forecast of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Demand Forecasts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"scenario_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollment",
|
|
"visits",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand forecast.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/externalEnrollments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of external enrollments of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"External Enrollment Time Series"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"studyID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"enrollmentDate",
|
|
"enrollmentDate desc",
|
|
"enrollmentWeekDate",
|
|
"enrollmentWeekDate desc",
|
|
"enrollmentValue",
|
|
"enrollmentValue desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"randomizationGroupUUID",
|
|
"randomizationGroupUUID desc",
|
|
"studyUUID",
|
|
"studyUUID desc",
|
|
"scenarioUUID",
|
|
"scenarioUUID desc",
|
|
"treatmentGroupUUID",
|
|
"treatmentGroupUUID desc",
|
|
"siteGroupUUID",
|
|
"siteGroupUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"siteGroupID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"enrollmentDate",
|
|
"enrollmentWeekDate",
|
|
"enrollmentValue",
|
|
"protocolID",
|
|
"randomizationGroupUUID",
|
|
"studyUUID",
|
|
"scenarioUUID",
|
|
"treatmentGroupUUID",
|
|
"siteGroupUUID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external enrollments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ExternalEnrollmentTimeSeries",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/randomizationGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of randomization groups of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"position",
|
|
"position desc",
|
|
"description",
|
|
"description desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"ratioMode_code",
|
|
"ratioMode_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of RandomizationGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/scenarioSiteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of scenario site groups of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"activatedSites",
|
|
"activatedSites desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/status": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve status of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Study Scenario Status"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/timelineSchedules": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of timeline schedules of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Study Timeline Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"TSID",
|
|
"TSID desc",
|
|
"TGID",
|
|
"TGID desc",
|
|
"TGID_INT",
|
|
"TGID_INT desc",
|
|
"TGUUID",
|
|
"TGUUID desc",
|
|
"RGID",
|
|
"RGID desc",
|
|
"RGID_INT",
|
|
"RGID_INT desc",
|
|
"RGUUID",
|
|
"RGUUID desc",
|
|
"title",
|
|
"title desc",
|
|
"subtitle",
|
|
"subtitle desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"rgPosition",
|
|
"rgPosition desc",
|
|
"tgPosition",
|
|
"tgPosition desc",
|
|
"isSync",
|
|
"isSync desc",
|
|
"offsetDays",
|
|
"offsetDays desc",
|
|
"offset",
|
|
"offset desc",
|
|
"offsetUnit",
|
|
"offsetUnit desc",
|
|
"rgFSFV",
|
|
"rgFSFV desc",
|
|
"tgFSFV",
|
|
"tgFSFV desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"SpecificTreatmentSchedules_ID",
|
|
"SpecificTreatmentSchedules_ID desc",
|
|
"SpecificDeSyncTGs_TGUUID",
|
|
"SpecificDeSyncTGs_TGUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"TSID",
|
|
"TGID",
|
|
"TGID_INT",
|
|
"TGUUID",
|
|
"RGID",
|
|
"RGID_INT",
|
|
"RGUUID",
|
|
"title",
|
|
"subtitle",
|
|
"scenario_ID",
|
|
"siteGroupId",
|
|
"firstSubjectFirstVisit",
|
|
"rgPosition",
|
|
"tgPosition",
|
|
"isSync",
|
|
"offsetDays",
|
|
"offset",
|
|
"offsetUnit",
|
|
"rgFSFV",
|
|
"tgFSFV",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"SpecificTreatmentSchedules_ID",
|
|
"SpecificDeSyncTGs_TGUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"periods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved timeline schedules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineSchedules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Scenarios({ID})/treatments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Scenarios entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatments of a scenario.",
|
|
"tags": [
|
|
"Scenarios",
|
|
"Study Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"description",
|
|
"description desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentID",
|
|
"description",
|
|
"scenario_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"study",
|
|
"kitTypeAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of site groups.",
|
|
"tags": [
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"depotBuffer",
|
|
"depotBuffer desc",
|
|
"shipLeadTime",
|
|
"shipLeadTime desc",
|
|
"siteBuffer",
|
|
"siteBuffer desc",
|
|
"countryId",
|
|
"countryId desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"centralDepot_ID",
|
|
"centralDepot_ID desc",
|
|
"distrDepot_ID",
|
|
"distrDepot_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of SiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of SiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single site group.",
|
|
"tags": [
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups({ID})/centralDepot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of SiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve central depot of a site group.",
|
|
"tags": [
|
|
"Site Groups",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved central depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups({ID})/distrDepot": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of SiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve distr depot of a site group.",
|
|
"tags": [
|
|
"Site Groups",
|
|
"Cached MRP Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"mrpAreaText"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved distr depot.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups({ID})/siteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of SiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve site group of a site group.",
|
|
"tags": [
|
|
"Site Groups",
|
|
"Cached Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"description",
|
|
"country_countryId",
|
|
"materialPooling"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"country",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/SiteGroups({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of SiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a site group.",
|
|
"tags": [
|
|
"Site Groups",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies": {
|
|
"get": {
|
|
"summary": "Retrieve a list of studies.",
|
|
"tags": [
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"CTSMStudyID",
|
|
"CTSMStudyID desc",
|
|
"CTSMProtocolID",
|
|
"CTSMProtocolID desc",
|
|
"description",
|
|
"description desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"lastSubjectLastVisit",
|
|
"lastSubjectLastVisit desc",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningOn desc",
|
|
"pushedToSupplyPlanningBy",
|
|
"pushedToSupplyPlanningBy desc",
|
|
"isSiteLevelTracking",
|
|
"isSiteLevelTracking desc",
|
|
"eudraCT",
|
|
"eudraCT desc",
|
|
"hasKitTypeSpecificDepots",
|
|
"hasKitTypeSpecificDepots desc",
|
|
"openLabel",
|
|
"openLabel desc",
|
|
"isLeanStudy",
|
|
"isLeanStudy desc",
|
|
"isMultiprotocol",
|
|
"isMultiprotocol desc",
|
|
"isTGwithOffsets",
|
|
"isTGwithOffsets desc",
|
|
"actualManagement",
|
|
"actualManagement desc",
|
|
"planningHorizonStart",
|
|
"planningHorizonStart desc",
|
|
"planningHorizonEnd",
|
|
"planningHorizonEnd desc",
|
|
"sponsor_personNumber",
|
|
"sponsor_personNumber desc",
|
|
"isLinkedCTMS",
|
|
"isLinkedCTMS desc",
|
|
"status_code",
|
|
"status_code desc",
|
|
"studyType_ID",
|
|
"studyType_ID desc",
|
|
"studyPhase_ID",
|
|
"studyPhase_ID desc",
|
|
"leadMolecule_ID",
|
|
"leadMolecule_ID desc",
|
|
"therapeuticArea_ID",
|
|
"therapeuticArea_ID desc",
|
|
"distrTemplateId_ID",
|
|
"distrTemplateId_ID desc",
|
|
"blindingScenario_ID",
|
|
"blindingScenario_ID desc",
|
|
"costObject_ID",
|
|
"costObject_ID desc",
|
|
"costObject_type",
|
|
"costObject_type desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved studies.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Studies",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
},
|
|
"post": {
|
|
"summary": "Create a single study.",
|
|
"tags": [
|
|
"Studies"
|
|
],
|
|
"requestBody": {
|
|
"description": "New study",
|
|
"required": true,
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"201": {
|
|
"description": "Created study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study.",
|
|
"tags": [
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/actualsSourceSetting": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve actuals source setting of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Actuals Source Settings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CTSMProtocolID",
|
|
"IRTIdentifier"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved actuals source setting.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/blindingGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of blinding groups of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Blinding Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"blindingGroupID",
|
|
"blindingGroupID desc",
|
|
"blindingGroupDescription",
|
|
"blindingGroupDescription desc",
|
|
"blindedDescription",
|
|
"blindedDescription desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingGroupID",
|
|
"blindingGroupDescription",
|
|
"blindedDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of BlindingGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/blindingScenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve blinding scenario of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Blinding Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"blindingStrategyDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved blinding scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/contacts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of contacts of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Contacts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"parentID",
|
|
"parentID desc",
|
|
"description",
|
|
"description desc",
|
|
"firstName",
|
|
"firstName desc",
|
|
"lastName",
|
|
"lastName desc",
|
|
"email",
|
|
"email desc",
|
|
"phoneNumber",
|
|
"phoneNumber desc",
|
|
"cachedPerson_personNumber",
|
|
"cachedPerson_personNumber desc",
|
|
"userSource",
|
|
"userSource desc",
|
|
"role_ID",
|
|
"role_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"parentID",
|
|
"description",
|
|
"firstName",
|
|
"lastName",
|
|
"email",
|
|
"phoneNumber",
|
|
"cachedPerson_personNumber",
|
|
"userSource",
|
|
"role_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"role",
|
|
"person"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved contacts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Contacts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/costObject": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve cost object of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Cost Object"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"refreshedAt",
|
|
"ID",
|
|
"type",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"typeText",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved cost object.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/demand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demands of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"studyDemandID",
|
|
"studyDemandID desc",
|
|
"processedOn",
|
|
"processedOn desc",
|
|
"processedBy",
|
|
"processedBy desc",
|
|
"pushStatus",
|
|
"pushStatus desc",
|
|
"documentStatus",
|
|
"documentStatus desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyDemands",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/distrTemplateId": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve distr template id of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Cached Distributing Templates"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved distr template id.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/externalEnrollments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of external enrollments of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"External Enrollment Time Series"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"studyID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"enrollmentDate",
|
|
"enrollmentDate desc",
|
|
"enrollmentWeekDate",
|
|
"enrollmentWeekDate desc",
|
|
"enrollmentValue",
|
|
"enrollmentValue desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"randomizationGroupUUID",
|
|
"randomizationGroupUUID desc",
|
|
"studyUUID",
|
|
"studyUUID desc",
|
|
"scenarioUUID",
|
|
"scenarioUUID desc",
|
|
"treatmentGroupUUID",
|
|
"treatmentGroupUUID desc",
|
|
"siteGroupUUID",
|
|
"siteGroupUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"siteGroupID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"enrollmentDate",
|
|
"enrollmentWeekDate",
|
|
"enrollmentValue",
|
|
"protocolID",
|
|
"randomizationGroupUUID",
|
|
"studyUUID",
|
|
"scenarioUUID",
|
|
"treatmentGroupUUID",
|
|
"siteGroupUUID"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external enrollments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of ExternalEnrollmentTimeSeries",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/externalIdentifiers": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of external identifiers of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study External Identifier Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"value",
|
|
"value desc",
|
|
"externalIdentifier_ID",
|
|
"externalIdentifier_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"value",
|
|
"externalIdentifier_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"externalIdentifier",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external identifiers.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyExternalIdentifierAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/kitTypeTrees": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type trees of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Kit Type Tree Element"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"nodeID",
|
|
"nodeID desc",
|
|
"hierarchyLevel",
|
|
"hierarchyLevel desc",
|
|
"description",
|
|
"description desc",
|
|
"external_UUID",
|
|
"external_UUID desc",
|
|
"externalDescription",
|
|
"externalDescription desc",
|
|
"parentNodeID",
|
|
"parentNodeID desc",
|
|
"drillState",
|
|
"drillState desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_ID desc",
|
|
"blindingGroupDescription",
|
|
"blindingGroupDescription desc",
|
|
"distributingTemplate_ID",
|
|
"distributingTemplate_ID desc",
|
|
"distributingTemplateDescription",
|
|
"distributingTemplateDescription desc",
|
|
"materialDescription",
|
|
"materialDescription desc",
|
|
"kitTypeID_INT",
|
|
"kitTypeID_INT desc",
|
|
"businessID_INT",
|
|
"businessID_INT desc",
|
|
"labelGroup_ID",
|
|
"labelGroup_ID desc",
|
|
"countryID",
|
|
"countryID desc",
|
|
"countryAssignment_ID",
|
|
"countryAssignment_ID desc",
|
|
"adminType",
|
|
"adminType desc",
|
|
"siteAdminPeriod",
|
|
"siteAdminPeriod desc",
|
|
"serialization",
|
|
"serialization desc",
|
|
"kitTypePosition",
|
|
"kitTypePosition desc",
|
|
"labelGroupPosition",
|
|
"labelGroupPosition desc",
|
|
"HasActiveEntity",
|
|
"HasActiveEntity desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"nodeID",
|
|
"hierarchyLevel",
|
|
"description",
|
|
"external_UUID",
|
|
"externalDescription",
|
|
"parentNodeID",
|
|
"drillState",
|
|
"kitTypeID",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroupDescription",
|
|
"distributingTemplate_ID",
|
|
"distributingTemplateDescription",
|
|
"materialDescription",
|
|
"kitTypeID_INT",
|
|
"businessID_INT",
|
|
"labelGroup_ID",
|
|
"countryID",
|
|
"countryAssignment_ID",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"kitTypePosition",
|
|
"labelGroupPosition",
|
|
"HasActiveEntity"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type trees.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeTreeElement",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/kitTypes": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit types of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"description",
|
|
"description desc",
|
|
"position",
|
|
"position desc",
|
|
"adminType",
|
|
"adminType desc",
|
|
"siteAdminPeriod",
|
|
"siteAdminPeriod desc",
|
|
"serialization",
|
|
"serialization desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_ID desc",
|
|
"blindingGroup_BK",
|
|
"blindingGroup_BK desc",
|
|
"distrTemplateId_ID",
|
|
"distrTemplateId_ID desc",
|
|
"refKitType_RefKitTypeUUID",
|
|
"refKitType_RefKitTypeUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypes",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/labelGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of label groups of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Label Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"labelGroupID",
|
|
"labelGroupID desc",
|
|
"labelGroupDescription",
|
|
"labelGroupDescription desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"labelGroupID",
|
|
"labelGroupDescription",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"labelGroupCountryAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved label groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LabelGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/leadMolecule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve lead molecule of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Lead Molecules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete",
|
|
"externalID",
|
|
"sourceSystem"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved lead molecule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/materials": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of materials of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"comment",
|
|
"comment desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"comment",
|
|
"material_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"material",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved materials.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyMaterials",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/protocols": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of protocols of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"comment",
|
|
"comment desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved protocols.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyProtocols",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/scenarios": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of scenarios of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"scenario_num",
|
|
"scenario_num desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"description",
|
|
"description desc",
|
|
"detailedDescription",
|
|
"detailedDescription desc",
|
|
"statusChangedAt",
|
|
"statusChangedAt desc",
|
|
"ctmProtocolUpdate",
|
|
"ctmProtocolUpdate desc",
|
|
"copiedFrom",
|
|
"copiedFrom desc",
|
|
"hasECManualToAutoChange",
|
|
"hasECManualToAutoChange desc",
|
|
"status_code",
|
|
"status_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenarios.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of Scenarios",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/siteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of site groups of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"depotBuffer",
|
|
"depotBuffer desc",
|
|
"shipLeadTime",
|
|
"shipLeadTime desc",
|
|
"siteBuffer",
|
|
"siteBuffer desc",
|
|
"countryId",
|
|
"countryId desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"centralDepot_ID",
|
|
"centralDepot_ID desc",
|
|
"distrDepot_ID",
|
|
"distrDepot_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of SiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/status": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve status of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"code",
|
|
"description",
|
|
"smEnable",
|
|
"dfEnable",
|
|
"kitIDGenerateEnable",
|
|
"pushSupplyPlanningEnable",
|
|
"IRTImportEnable",
|
|
"distributionEnable",
|
|
"protocalIdEnable",
|
|
"deletionEnable",
|
|
"studyCompleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/studyPhase": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study phase of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Phases"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"isObsolete",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study phase.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/studyType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study type of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Study Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/Studies({ID})/therapeuticArea": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of Studies entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve therapeutic area of a study.",
|
|
"tags": [
|
|
"Studies",
|
|
"Therapeutic Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"therapeuticAreaDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved therapeutic area.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyActualsSourceSettings": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study actuals source settings.",
|
|
"tags": [
|
|
"Study Actuals Source Settings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CTSMProtocolID",
|
|
"CTSMProtocolID desc",
|
|
"IRTIdentifier",
|
|
"IRTIdentifier desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CTSMProtocolID",
|
|
"IRTIdentifier"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study actuals source settings.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyActualsSourceSettings",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyActualsSourceSettings('{CTSMProtocolID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: CTSMProtocolID",
|
|
"in": "path",
|
|
"name": "CTSMProtocolID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study actuals source setting.",
|
|
"tags": [
|
|
"Study Actuals Source Settings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"CTSMProtocolID",
|
|
"IRTIdentifier"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study actuals source setting.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study demands.",
|
|
"tags": [
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"studyDemandID",
|
|
"studyDemandID desc",
|
|
"processedOn",
|
|
"processedOn desc",
|
|
"processedBy",
|
|
"processedBy desc",
|
|
"pushStatus",
|
|
"pushStatus desc",
|
|
"documentStatus",
|
|
"documentStatus desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study demands.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyDemands",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study demand.",
|
|
"tags": [
|
|
"Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"studyDemandID",
|
|
"processedOn",
|
|
"processedBy",
|
|
"pushStatus",
|
|
"documentStatus",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"demands",
|
|
"demandSiteGroups",
|
|
"demandBuckets",
|
|
"demandsPresentation"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})/demandBuckets": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demand buckets of a study demand.",
|
|
"tags": [
|
|
"Study Demands",
|
|
"Lean Study Demand Buckets"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyDemandUUID",
|
|
"studyDemandUUID desc",
|
|
"dateValue",
|
|
"dateValue desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyDemandUUID",
|
|
"dateValue"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand buckets.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandBuckets",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})/demandSiteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demand site groups of a study demand.",
|
|
"tags": [
|
|
"Study Demands",
|
|
"Lean Study Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"demand_ID",
|
|
"demand_ID desc",
|
|
"pushedOn",
|
|
"pushedOn desc",
|
|
"pushedBy",
|
|
"pushedBy desc",
|
|
"pushStatus",
|
|
"pushStatus desc",
|
|
"interimStatus",
|
|
"interimStatus desc",
|
|
"pushedScheAgrCount",
|
|
"pushedScheAgrCount desc",
|
|
"pushEpoch",
|
|
"pushEpoch desc",
|
|
"successPushOn",
|
|
"successPushOn desc",
|
|
"successPushBy",
|
|
"successPushBy desc",
|
|
"documentNumber",
|
|
"documentNumber desc",
|
|
"documentStatus",
|
|
"documentStatus desc",
|
|
"isKitTypeSpecific",
|
|
"isKitTypeSpecific desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc",
|
|
"kitTypeSiteGroup_ID",
|
|
"kitTypeSiteGroup_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"isActive",
|
|
"isActive desc",
|
|
"protocolIDLabel",
|
|
"protocolIDLabel desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"demand_ID",
|
|
"pushedOn",
|
|
"pushedBy",
|
|
"pushStatus",
|
|
"interimStatus",
|
|
"pushedScheAgrCount",
|
|
"pushEpoch",
|
|
"successPushOn",
|
|
"successPushBy",
|
|
"documentNumber",
|
|
"documentStatus",
|
|
"isKitTypeSpecific",
|
|
"studySiteGroup_ID",
|
|
"kitTypeSiteGroup_ID",
|
|
"protocol_ID",
|
|
"isActive",
|
|
"protocolIDLabel"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"demand",
|
|
"pushStatusDescription",
|
|
"documentStatusDescription",
|
|
"logEntries",
|
|
"studySiteGroup",
|
|
"kitTypeSiteGroup",
|
|
"protocol"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demand site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudySiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})/demands": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demands of a study demand.",
|
|
"tags": [
|
|
"Study Demands",
|
|
"Lean Study Demands"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"protocol_BK",
|
|
"protocol_BK desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"kittype_BK",
|
|
"kittype_BK desc",
|
|
"material_ID",
|
|
"material_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"protocol_BK",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"kittype_BK",
|
|
"material_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demands.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemands",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})/demandsPresentation": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of demands presentations of a study demand.",
|
|
"tags": [
|
|
"Study Demands",
|
|
"Lean Study Demands Presentation"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"studyDemand_ID",
|
|
"studyDemand_ID desc",
|
|
"protocol_ID",
|
|
"protocol_ID desc",
|
|
"depot_ID",
|
|
"depot_ID desc",
|
|
"siteGroup_ID",
|
|
"siteGroup_ID desc",
|
|
"kittype_ID",
|
|
"kittype_ID desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"doNotShip",
|
|
"doNotShip desc",
|
|
"dateValue",
|
|
"dateValue desc",
|
|
"demandValue",
|
|
"demandValue desc",
|
|
"dummy",
|
|
"dummy desc",
|
|
"dummyExpands",
|
|
"dummyExpands desc",
|
|
"leanStudyDemandUUID",
|
|
"leanStudyDemandUUID desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"depotID",
|
|
"depotID desc",
|
|
"depotDescription",
|
|
"depotDescription desc",
|
|
"siteGroupID",
|
|
"siteGroupID desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"kitTypeDescription",
|
|
"kitTypeDescription desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"materialID",
|
|
"materialID desc",
|
|
"materialDescription",
|
|
"materialDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"studyDemand_ID",
|
|
"protocol_ID",
|
|
"depot_ID",
|
|
"siteGroup_ID",
|
|
"kittype_ID",
|
|
"material_ID",
|
|
"doNotShip",
|
|
"dateValue",
|
|
"demandValue",
|
|
"dummy",
|
|
"dummyExpands",
|
|
"leanStudyDemandUUID",
|
|
"protocolID",
|
|
"depotID",
|
|
"depotDescription",
|
|
"siteGroupID",
|
|
"siteGroupDescription",
|
|
"kitTypeDescription",
|
|
"kitTypeID",
|
|
"materialID",
|
|
"materialDescription"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"studyDemand",
|
|
"protocol",
|
|
"depot",
|
|
"siteGroup",
|
|
"kittype",
|
|
"material",
|
|
"bucketValues"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved demands presentation.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of LeanStudyDemandsPresentation",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDemands({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDemands entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a study demand.",
|
|
"tags": [
|
|
"Study Demands",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDispensationTreatmentAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study dispensation treatment assignments.",
|
|
"tags": [
|
|
"Study Dispensation Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"treatment_BK",
|
|
"treatment_BK desc",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatmentDispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatment_BK",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentDispensationEvent",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study dispensation treatment assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyDispensationTreatmentAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDispensationTreatmentAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDispensationTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study dispensation treatment assignment.",
|
|
"tags": [
|
|
"Study Dispensation Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatment_BK",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentDispensationEvent",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study dispensation treatment assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDispensationTreatmentAssignments({ID})/treatment": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDispensationTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve the treatment of a study dispensation treatment assignment.",
|
|
"tags": [
|
|
"Study Dispensation Treatment Assignments",
|
|
"Study Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentID",
|
|
"description",
|
|
"scenario_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"study",
|
|
"kitTypeAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyDispensationTreatmentAssignments({ID})/treatmentDispensationEvent": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyDispensationTreatmentAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment dispensation event of a study dispensation treatment assignment.",
|
|
"tags": [
|
|
"Study Dispensation Treatment Assignments",
|
|
"Study Treatment Dispensation Events"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"dispensationEventID",
|
|
"description",
|
|
"treatmentPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentPeriod",
|
|
"treatmentAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment dispensation event.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyEnrollmentCurves": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study enrollment curves.",
|
|
"tags": [
|
|
"Study Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"studyID desc",
|
|
"scenarioID",
|
|
"scenarioID desc",
|
|
"randomizationGroupID",
|
|
"randomizationGroupID desc",
|
|
"treatmentGroupID",
|
|
"treatmentGroupID desc",
|
|
"scenarioSiteGroupID",
|
|
"scenarioSiteGroupID desc",
|
|
"treatmentGroupSiteGroupID",
|
|
"treatmentGroupSiteGroupID desc",
|
|
"enrollmentCurveID",
|
|
"enrollmentCurveID desc",
|
|
"studyBusinessKey",
|
|
"studyBusinessKey desc",
|
|
"studyDescription",
|
|
"studyDescription desc",
|
|
"scenarioBusinessKey",
|
|
"scenarioBusinessKey desc",
|
|
"scenarioDescription",
|
|
"scenarioDescription desc",
|
|
"scenarioStatusDescription",
|
|
"scenarioStatusDescription desc",
|
|
"scenarioStatusCode",
|
|
"scenarioStatusCode desc",
|
|
"siteGroupBusinessKey",
|
|
"siteGroupBusinessKey desc",
|
|
"siteGroupDescription",
|
|
"siteGroupDescription desc",
|
|
"randomizationGroupBusinessKey",
|
|
"randomizationGroupBusinessKey desc",
|
|
"randomizationGroupDescription",
|
|
"randomizationGroupDescription desc",
|
|
"treatmentGroupBusinessKey",
|
|
"treatmentGroupBusinessKey desc",
|
|
"treatmentGroupDescription",
|
|
"treatmentGroupDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"scenarioSiteGroupID",
|
|
"treatmentGroupSiteGroupID",
|
|
"enrollmentCurveID",
|
|
"studyBusinessKey",
|
|
"studyDescription",
|
|
"scenarioBusinessKey",
|
|
"scenarioDescription",
|
|
"scenarioStatusDescription",
|
|
"scenarioStatusCode",
|
|
"siteGroupBusinessKey",
|
|
"siteGroupDescription",
|
|
"randomizationGroupBusinessKey",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroupBusinessKey",
|
|
"treatmentGroupDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study enrollment curves.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyEnrollmentCurves",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyEnrollmentCurves(studyID={studyID},scenarioID={scenarioID},randomizationGroupID={randomizationGroupID},treatmentGroupID={treatmentGroupID},scenarioSiteGroupID={scenarioSiteGroupID},treatmentGroupSiteGroupID={treatmentGroupSiteGroupID},enrollmentCurveID={enrollmentCurveID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: studyID",
|
|
"in": "path",
|
|
"name": "studyID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: scenarioID",
|
|
"in": "path",
|
|
"name": "scenarioID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: randomizationGroupID",
|
|
"in": "path",
|
|
"name": "randomizationGroupID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatmentGroupID",
|
|
"in": "path",
|
|
"name": "treatmentGroupID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: scenarioSiteGroupID",
|
|
"in": "path",
|
|
"name": "scenarioSiteGroupID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatmentGroupSiteGroupID",
|
|
"in": "path",
|
|
"name": "treatmentGroupSiteGroupID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: enrollmentCurveID",
|
|
"in": "path",
|
|
"name": "enrollmentCurveID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study enrollment curve.",
|
|
"tags": [
|
|
"Study Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"scenarioSiteGroupID",
|
|
"treatmentGroupSiteGroupID",
|
|
"enrollmentCurveID",
|
|
"studyBusinessKey",
|
|
"studyDescription",
|
|
"scenarioBusinessKey",
|
|
"scenarioDescription",
|
|
"scenarioStatusDescription",
|
|
"scenarioStatusCode",
|
|
"siteGroupBusinessKey",
|
|
"siteGroupDescription",
|
|
"randomizationGroupBusinessKey",
|
|
"randomizationGroupDescription",
|
|
"treatmentGroupBusinessKey",
|
|
"treatmentGroupDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study enrollment curve.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyExternalIdentifierAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study external identifier assignments.",
|
|
"tags": [
|
|
"Study External Identifier Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"value",
|
|
"value desc",
|
|
"externalIdentifier_ID",
|
|
"externalIdentifier_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"value",
|
|
"externalIdentifier_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"externalIdentifier",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study external identifier assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyExternalIdentifierAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyExternalIdentifierAssignments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyExternalIdentifierAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study external identifier assignment.",
|
|
"tags": [
|
|
"Study External Identifier Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"value",
|
|
"externalIdentifier_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"externalIdentifier",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study external identifier assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyExternalIdentifierAssignments({ID})/externalIdentifier": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyExternalIdentifierAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve external identifier of a study external identifier assignment.",
|
|
"tags": [
|
|
"Study External Identifier Assignments",
|
|
"External Identifiers"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"name",
|
|
"isVisible",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved external identifier.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyExternalIdentifierAssignments({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyExternalIdentifierAssignments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a study external identifier assignment.",
|
|
"tags": [
|
|
"Study External Identifier Assignments",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyMaterials": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study materials.",
|
|
"tags": [
|
|
"Study Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"comment",
|
|
"comment desc",
|
|
"material_ID",
|
|
"material_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"comment",
|
|
"material_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"material",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study materials.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyMaterials",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyMaterials({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyMaterials entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study material.",
|
|
"tags": [
|
|
"Study Materials"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"comment",
|
|
"material_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"material",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study material.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyMaterials({ID})/material": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyMaterials entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve data on a study material.",
|
|
"tags": [
|
|
"Study Materials",
|
|
"Materials View"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"materialID",
|
|
"baseUnit",
|
|
"numberOfDecimals",
|
|
"description",
|
|
"crossStudy",
|
|
"category",
|
|
"materialTypeName",
|
|
"source",
|
|
"status"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved material data.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyMaterials({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyMaterials entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study data for a study material.",
|
|
"tags": [
|
|
"Study Materials",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study data.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study phases.",
|
|
"tags": [
|
|
"Study Phases"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"sort_num",
|
|
"sort_num desc",
|
|
"ID",
|
|
"ID desc",
|
|
"isObsolete",
|
|
"isObsolete desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"isObsolete",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study phases.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyPhases",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study phase.",
|
|
"tags": [
|
|
"Study Phases"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"isObsolete",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study phase.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a study phase.",
|
|
"tags": [
|
|
"Study Phases",
|
|
"Study Phases texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a study phase.",
|
|
"tags": [
|
|
"Study Phases",
|
|
"Study Phases texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved descriptions.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyPhases_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study phase descriptions.",
|
|
"tags": [
|
|
"Study Phases texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study phase descriptions.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyPhases_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyPhases_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study phase description.",
|
|
"tags": [
|
|
"Study Phases texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study phase description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyProtocols": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study protocols.",
|
|
"tags": [
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"protocolID",
|
|
"protocolID desc",
|
|
"comment",
|
|
"comment desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study protocols.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyProtocols",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyProtocols({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyProtocols entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study protocol.",
|
|
"tags": [
|
|
"Study Protocols"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"protocolID",
|
|
"comment",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study protocol.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyProtocols({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyProtocols entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study data for a study protocol.",
|
|
"tags": [
|
|
"Study Protocols",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study data.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study regulatory statuses.",
|
|
"tags": [
|
|
"Study Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study regulatory statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyRegulatoryStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study regulatory status.",
|
|
"tags": [
|
|
"Study Regulatory Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study regulatory status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a study regulatory status.",
|
|
"tags": [
|
|
"Study Regulatory Statuses",
|
|
"Study Regulatory Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyRegulatoryStatuses entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of texts of a study regulatory status.",
|
|
"tags": [
|
|
"Study Regulatory Statuses",
|
|
"Study Regulatory Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyRegulatoryStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study regulatory statuses_texts.",
|
|
"tags": [
|
|
"Study Regulatory Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study regulatory statuses_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyRegulatoryStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyRegulatoryStatuses_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study regulatory statuses_text.",
|
|
"tags": [
|
|
"Study Regulatory Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study regulatory statuses_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioAdditionalDemand": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study scenario additional demands.",
|
|
"tags": [
|
|
"Study Scenario Additional Demand"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"totalKits",
|
|
"totalKits desc",
|
|
"demandDate",
|
|
"demandDate desc",
|
|
"comment",
|
|
"comment desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"totalKits",
|
|
"demandDate",
|
|
"comment",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario additional demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioAdditionalDemand",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioAdditionalDemand({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioAdditionalDemand entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study scenario additional demand.",
|
|
"tags": [
|
|
"Study Scenario Additional Demand"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"totalKits",
|
|
"demandDate",
|
|
"comment",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario additional demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioAdditionalDemand({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioAdditionalDemand entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a study scenario additional demand.",
|
|
"tags": [
|
|
"Study Scenario Additional Demand",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioAdditionalDemand({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioAdditionalDemand entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study scenario additional demand.",
|
|
"tags": [
|
|
"Study Scenario Additional Demand",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioAdditionalDemand({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioAdditionalDemand entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group of a study scenario additional demand.",
|
|
"tags": [
|
|
"Study Scenario Additional Demand",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study scenario site groups.",
|
|
"tags": [
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"activatedSites",
|
|
"activatedSites desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"studySiteGroup_ID",
|
|
"studySiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study scenario site group.",
|
|
"tags": [
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study scenario site group.",
|
|
"tags": [
|
|
"Study Scenario Site Groups",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups({ID})/scenarioAdditionalDemand": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of scenario additional demands of a study scenario site group.",
|
|
"tags": [
|
|
"Study Scenario Site Groups",
|
|
"Study Scenario Additional Demand"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"totalKits",
|
|
"totalKits desc",
|
|
"demandDate",
|
|
"demandDate desc",
|
|
"comment",
|
|
"comment desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"totalKits",
|
|
"demandDate",
|
|
"comment",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario additional demand.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioAdditionalDemand",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups({ID})/scenarioSiteSeeding": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of scenario site seedings of a study scenario site group.",
|
|
"tags": [
|
|
"Study Scenario Site Groups",
|
|
"Study Scenario Site Seedings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"seedingGroupID",
|
|
"seedingGroupID desc",
|
|
"suppliedSites",
|
|
"suppliedSites desc",
|
|
"kitsPerSite",
|
|
"kitsPerSite desc",
|
|
"FSFVOffset",
|
|
"FSFVOffset desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"seedingGroupID",
|
|
"suppliedSites",
|
|
"kitsPerSite",
|
|
"FSFVOffset",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site seeding.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioSiteSeedings",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteGroups({ID})/studySiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study site group of a study scenario site group.",
|
|
"tags": [
|
|
"Study Scenario Site Groups",
|
|
"Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"depotBuffer",
|
|
"shipLeadTime",
|
|
"siteBuffer",
|
|
"countryId",
|
|
"siteGroup_ID",
|
|
"study_ID",
|
|
"centralDepot_ID",
|
|
"distrDepot_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"siteGroup",
|
|
"study",
|
|
"centralDepot",
|
|
"distrDepot"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteSeedings": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study scenario site seedings.",
|
|
"tags": [
|
|
"Study Scenario Site Seedings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"seedingGroupID",
|
|
"seedingGroupID desc",
|
|
"suppliedSites",
|
|
"suppliedSites desc",
|
|
"kitsPerSite",
|
|
"kitsPerSite desc",
|
|
"FSFVOffset",
|
|
"FSFVOffset desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"seedingGroupID",
|
|
"suppliedSites",
|
|
"kitsPerSite",
|
|
"FSFVOffset",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario site seedings.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioSiteSeedings",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteSeedings({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteSeedings entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study scenario site seeding.",
|
|
"tags": [
|
|
"Study Scenario Site Seedings"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"seedingGroupID",
|
|
"suppliedSites",
|
|
"kitsPerSite",
|
|
"FSFVOffset",
|
|
"kitType_BK",
|
|
"scenario_ID",
|
|
"kitType_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"kitType",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario site seeding.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteSeedings({ID})/kitType": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteSeedings entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve kit type of a study scenario site seeding.",
|
|
"tags": [
|
|
"Study Scenario Site Seedings",
|
|
"Kit Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"kitTypeID",
|
|
"description",
|
|
"position",
|
|
"adminType",
|
|
"siteAdminPeriod",
|
|
"serialization",
|
|
"study_ID",
|
|
"blindingGroup_ID",
|
|
"blindingGroup_BK",
|
|
"distrTemplateId_ID",
|
|
"refKitType_RefKitTypeUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"blindingGroup",
|
|
"distrTemplateId",
|
|
"refKitType",
|
|
"kitTypeMolecules",
|
|
"labelGroupAssignments",
|
|
"countrySiteGroupDepots",
|
|
"countryLabelGroups",
|
|
"countryMaterials"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteSeedings({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteSeedings entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study scenario site seeding.",
|
|
"tags": [
|
|
"Study Scenario Site Seedings",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioSiteSeedings({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyScenarioSiteSeedings entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group of a study scenario site seeding.",
|
|
"tags": [
|
|
"Study Scenario Site Seedings",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study scenario statuses.",
|
|
"tags": [
|
|
"Study Scenario Status"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioStatus",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus({code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyScenarioStatus entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study scenario status.",
|
|
"tags": [
|
|
"Study Scenario Status"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus({code})/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyScenarioStatus entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a study scenario status.",
|
|
"tags": [
|
|
"Study Scenario Status",
|
|
"Study Scenario Status texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus({code})/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code (business key) of StudyScenarioStatus entity.",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a study scenario status.",
|
|
"tags": [
|
|
"Study Scenario Status",
|
|
"Study Scenario Status texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioStatus_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study scenario status_texts.",
|
|
"tags": [
|
|
"Study Scenario Status texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario status_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyScenarioStatus_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyScenarioStatus_texts(locale='{locale}',code={code})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: locale",
|
|
"in": "path",
|
|
"name": "locale",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study scenario status_text.",
|
|
"tags": [
|
|
"Study Scenario Status texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study scenario status_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study statuses.",
|
|
"tags": [
|
|
"Study Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc",
|
|
"smEnable",
|
|
"smEnable desc",
|
|
"dfEnable",
|
|
"dfEnable desc",
|
|
"kitIDGenerateEnable",
|
|
"kitIDGenerateEnable desc",
|
|
"pushSupplyPlanningEnable",
|
|
"pushSupplyPlanningEnable desc",
|
|
"IRTImportEnable",
|
|
"IRTImportEnable desc",
|
|
"distributionEnable",
|
|
"distributionEnable desc",
|
|
"protocalIdEnable",
|
|
"protocalIdEnable desc",
|
|
"deletionEnable",
|
|
"deletionEnable desc",
|
|
"studyCompleted",
|
|
"studyCompleted desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"code",
|
|
"description",
|
|
"smEnable",
|
|
"dfEnable",
|
|
"kitIDGenerateEnable",
|
|
"pushSupplyPlanningEnable",
|
|
"IRTImportEnable",
|
|
"distributionEnable",
|
|
"protocalIdEnable",
|
|
"deletionEnable",
|
|
"studyCompleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyStatuses('{code}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study status.",
|
|
"tags": [
|
|
"Study Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"code",
|
|
"description",
|
|
"smEnable",
|
|
"dfEnable",
|
|
"kitIDGenerateEnable",
|
|
"pushSupplyPlanningEnable",
|
|
"IRTImportEnable",
|
|
"distributionEnable",
|
|
"protocalIdEnable",
|
|
"deletionEnable",
|
|
"studyCompleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyStatuses('{code}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: code",
|
|
"in": "path",
|
|
"name": "code",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a study status.",
|
|
"tags": [
|
|
"Study Statuses",
|
|
"Study Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyStatuses_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study statuses_texts.",
|
|
"tags": [
|
|
"Study Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"code",
|
|
"code desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study statuses_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyStatuses_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyStatuses_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study statuses_text.",
|
|
"tags": [
|
|
"Study Statuses texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"code",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study statuses_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineKitTypeAssignments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study timeline kit type assignments.",
|
|
"tags": [
|
|
"Study Timeline Kit Type Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc",
|
|
"kitTypeAssignment_ID",
|
|
"kitTypeAssignment_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"quantity",
|
|
"quantity desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"validTo",
|
|
"validTo desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"kitTypeAssignment_ID",
|
|
"kitType_ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"kitTypeID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline kit type assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineKitTypeAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineKitTypeAssignments(dispensationEvent_ID={dispensationEvent_ID},treatment_ID={treatment_ID},kitTypeAssignment_ID={kitTypeAssignment_ID},kitType_ID={kitType_ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: dispensationEvent_ID",
|
|
"in": "path",
|
|
"name": "dispensationEvent_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatment_ID",
|
|
"in": "path",
|
|
"name": "treatment_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: kitTypeAssignment_ID",
|
|
"in": "path",
|
|
"name": "kitTypeAssignment_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: kitType_ID",
|
|
"in": "path",
|
|
"name": "kitType_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study timeline kit type assignment.",
|
|
"tags": [
|
|
"Study Timeline Kit Type Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"kitTypeAssignment_ID",
|
|
"kitType_ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"kitTypeID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline kit type assignment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelinePeriods": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study timeline periods.",
|
|
"tags": [
|
|
"Study Timeline Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"description",
|
|
"description desc",
|
|
"durationInDays",
|
|
"durationInDays desc",
|
|
"position",
|
|
"position desc",
|
|
"startDay",
|
|
"startDay desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"colorCode",
|
|
"colorCode desc",
|
|
"overage",
|
|
"overage desc",
|
|
"dropout",
|
|
"dropout desc",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatmentDispensationEvent_ID desc",
|
|
"switchFromRate",
|
|
"switchFromRate desc",
|
|
"switchToRate",
|
|
"switchToRate desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatmentGroup_ID",
|
|
"treatmentSchedule_ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentDispensationEvent_ID",
|
|
"switchFromRate",
|
|
"switchToRate"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline periods.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelinePeriods",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelinePeriods({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTimelinePeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study timeline period.",
|
|
"tags": [
|
|
"Study Timeline Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatmentGroup_ID",
|
|
"treatmentSchedule_ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentDispensationEvent_ID",
|
|
"switchFromRate",
|
|
"switchToRate"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelinePeriods({ID})/treatments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTimelinePeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatments of a study timeline period.",
|
|
"tags": [
|
|
"Study Timeline Periods",
|
|
"Study Timeline Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc",
|
|
"period_ID",
|
|
"period_ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"treatment_num",
|
|
"treatment_num desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"period_ID",
|
|
"treatmentID",
|
|
"treatment_num",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitTypes"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineSchedules": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study timeline schedules.",
|
|
"tags": [
|
|
"Study Timeline Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"TSID",
|
|
"TSID desc",
|
|
"TGID",
|
|
"TGID desc",
|
|
"TGID_INT",
|
|
"TGID_INT desc",
|
|
"TGUUID",
|
|
"TGUUID desc",
|
|
"RGID",
|
|
"RGID desc",
|
|
"RGID_INT",
|
|
"RGID_INT desc",
|
|
"RGUUID",
|
|
"RGUUID desc",
|
|
"title",
|
|
"title desc",
|
|
"subtitle",
|
|
"subtitle desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"rgPosition",
|
|
"rgPosition desc",
|
|
"tgPosition",
|
|
"tgPosition desc",
|
|
"isSync",
|
|
"isSync desc",
|
|
"offsetDays",
|
|
"offsetDays desc",
|
|
"offset",
|
|
"offset desc",
|
|
"offsetUnit",
|
|
"offsetUnit desc",
|
|
"rgFSFV",
|
|
"rgFSFV desc",
|
|
"tgFSFV",
|
|
"tgFSFV desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"SpecificTreatmentSchedules_ID",
|
|
"SpecificTreatmentSchedules_ID desc",
|
|
"SpecificDeSyncTGs_TGUUID",
|
|
"SpecificDeSyncTGs_TGUUID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"TSID",
|
|
"TGID",
|
|
"TGID_INT",
|
|
"TGUUID",
|
|
"RGID",
|
|
"RGID_INT",
|
|
"RGUUID",
|
|
"title",
|
|
"subtitle",
|
|
"scenario_ID",
|
|
"siteGroupId",
|
|
"firstSubjectFirstVisit",
|
|
"rgPosition",
|
|
"tgPosition",
|
|
"isSync",
|
|
"offsetDays",
|
|
"offset",
|
|
"offsetUnit",
|
|
"rgFSFV",
|
|
"tgFSFV",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"SpecificTreatmentSchedules_ID",
|
|
"SpecificDeSyncTGs_TGUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"periods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline schedules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineSchedules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineSchedules({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTimelineSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study timeline schedule.",
|
|
"tags": [
|
|
"Study Timeline Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"TSID",
|
|
"TGID",
|
|
"TGID_INT",
|
|
"TGUUID",
|
|
"RGID",
|
|
"RGID_INT",
|
|
"RGUUID",
|
|
"title",
|
|
"subtitle",
|
|
"scenario_ID",
|
|
"siteGroupId",
|
|
"firstSubjectFirstVisit",
|
|
"rgPosition",
|
|
"tgPosition",
|
|
"isSync",
|
|
"offsetDays",
|
|
"offset",
|
|
"offsetUnit",
|
|
"rgFSFV",
|
|
"tgFSFV",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"SpecificTreatmentSchedules_ID",
|
|
"SpecificDeSyncTGs_TGUUID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"periods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineSchedules({ID})/periods": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTimelineSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of periods of a study timeline schedule.",
|
|
"tags": [
|
|
"Study Timeline Schedules",
|
|
"Study Timeline Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"description",
|
|
"description desc",
|
|
"durationInDays",
|
|
"durationInDays desc",
|
|
"position",
|
|
"position desc",
|
|
"startDay",
|
|
"startDay desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"colorCode",
|
|
"colorCode desc",
|
|
"overage",
|
|
"overage desc",
|
|
"dropout",
|
|
"dropout desc",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatmentDispensationEvent_ID desc",
|
|
"switchFromRate",
|
|
"switchFromRate desc",
|
|
"switchToRate",
|
|
"switchToRate desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatmentGroup_ID",
|
|
"treatmentSchedule_ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentDispensationEvent_ID",
|
|
"switchFromRate",
|
|
"switchToRate"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved periods.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelinePeriods",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineTreatments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study timeline treatments.",
|
|
"tags": [
|
|
"Study Timeline Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc",
|
|
"period_ID",
|
|
"period_ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"treatment_num",
|
|
"treatment_num desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"period_ID",
|
|
"treatmentID",
|
|
"treatment_num",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitTypes"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineTreatments(dispensationEvent_ID={dispensationEvent_ID},treatment_ID={treatment_ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: dispensationEvent_ID",
|
|
"in": "path",
|
|
"name": "dispensationEvent_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatment_ID",
|
|
"in": "path",
|
|
"name": "treatment_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study timeline treatment.",
|
|
"tags": [
|
|
"Study Timeline Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"period_ID",
|
|
"treatmentID",
|
|
"treatment_num",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"kitTypes"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study timeline treatment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTimelineTreatments(dispensationEvent_ID={dispensationEvent_ID},treatment_ID={treatment_ID})/kitTypes": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: dispensationEvent_ID",
|
|
"in": "path",
|
|
"name": "dispensationEvent_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
{
|
|
"description": "Key: treatment_ID",
|
|
"in": "path",
|
|
"name": "treatment_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit types of a study timeline treatment.",
|
|
"tags": [
|
|
"Study Timeline Treatments",
|
|
"Study Timeline Kit Type Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc",
|
|
"kitTypeAssignment_ID",
|
|
"kitTypeAssignment_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"quantity",
|
|
"quantity desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"validTo",
|
|
"validTo desc",
|
|
"kitTypeID",
|
|
"kitTypeID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"kitTypeAssignment_ID",
|
|
"kitType_ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"kitTypeID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTimelineKitTypeAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitionStatuses": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study transition statuses.",
|
|
"tags": [
|
|
"Study Transition Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"transitionStatus_code",
|
|
"transitionStatus_code desc",
|
|
"transition_ID",
|
|
"transition_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"transitionStatus_code",
|
|
"transition_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"transitionStatus",
|
|
"transition"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study transition statuses.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTransitionStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitionStatuses({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTransitionStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study transition status.",
|
|
"tags": [
|
|
"Study Transition Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"transitionStatus_code",
|
|
"transition_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"transitionStatus",
|
|
"transition"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study transition status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitionStatuses({ID})/transition": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTransitionStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve transition of a study transition status.",
|
|
"tags": [
|
|
"Study Transition Statuses",
|
|
"Study Transitions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"startStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"startStatus",
|
|
"toStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved transition.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitionStatuses({ID})/transitionStatus": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTransitionStatuses entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve transition status (to-status) of a study status transition.",
|
|
"tags": [
|
|
"Study Transition Statuses",
|
|
"Study Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"code",
|
|
"description",
|
|
"smEnable",
|
|
"dfEnable",
|
|
"kitIDGenerateEnable",
|
|
"pushSupplyPlanningEnable",
|
|
"IRTImportEnable",
|
|
"distributionEnable",
|
|
"protocalIdEnable",
|
|
"deletionEnable",
|
|
"studyCompleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved transition status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitions": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study transitions.",
|
|
"tags": [
|
|
"Study Transitions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"startStatus_code",
|
|
"startStatus_code desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"startStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"startStatus",
|
|
"toStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study transitions.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTransitions",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitions('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study transition.",
|
|
"tags": [
|
|
"Study Transitions"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"startStatus_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"startStatus",
|
|
"toStatus"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study transition.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitions('{ID}')/startStatus": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve start status of a study transition.",
|
|
"tags": [
|
|
"Study Transitions",
|
|
"Study Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"code",
|
|
"description",
|
|
"smEnable",
|
|
"dfEnable",
|
|
"kitIDGenerateEnable",
|
|
"pushSupplyPlanningEnable",
|
|
"IRTImportEnable",
|
|
"distributionEnable",
|
|
"protocalIdEnable",
|
|
"deletionEnable",
|
|
"studyCompleted"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved start status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTransitions('{ID}')/toStatus": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of to-statuses of a study transition.",
|
|
"tags": [
|
|
"Study Transitions",
|
|
"Study Transition Statuses"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"transitionStatus_code",
|
|
"transitionStatus_code desc",
|
|
"transition_ID",
|
|
"transition_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"transitionStatus_code",
|
|
"transition_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"transitionStatus",
|
|
"transition"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved to status.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTransitionStatuses",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentDispensationEvents": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment dispensation events.",
|
|
"tags": [
|
|
"Study Treatment Dispensation Events"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"dispensationEventID",
|
|
"dispensationEventID desc",
|
|
"description",
|
|
"description desc",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"dispensationEventID",
|
|
"description",
|
|
"treatmentPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentPeriod",
|
|
"treatmentAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment dispensation events.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentDispensationEvents",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentDispensationEvents({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentDispensationEvents entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment dispensation event.",
|
|
"tags": [
|
|
"Study Treatment Dispensation Events"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"dispensationEventID",
|
|
"description",
|
|
"treatmentPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentPeriod",
|
|
"treatmentAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment dispensation event.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentDispensationEvents({ID})/treatmentAssignments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentDispensationEvents entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment assignments of a study treatment dispensation event.",
|
|
"tags": [
|
|
"Study Treatment Dispensation Events",
|
|
"Study Dispensation Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"treatment_BK",
|
|
"treatment_BK desc",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatmentDispensationEvent_ID desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"treatment_BK",
|
|
"treatmentDispensationEvent_ID",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentDispensationEvent",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyDispensationTreatmentAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentDispensationEvents({ID})/treatmentPeriod": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentDispensationEvents entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment period of a study treatment dispensation event.",
|
|
"tags": [
|
|
"Study Treatment Dispensation Events",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment groups.",
|
|
"tags": [
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"studyTreatmentGroupID",
|
|
"studyTreatmentGroupID desc",
|
|
"offset",
|
|
"offset desc",
|
|
"offsetUnit",
|
|
"offsetUnit desc",
|
|
"position",
|
|
"position desc",
|
|
"description",
|
|
"description desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"ratioPercent",
|
|
"ratioPercent desc",
|
|
"ratioAbsolute",
|
|
"ratioAbsolute desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment group.",
|
|
"tags": [
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups({ID})/randomizationGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve randomization group of a study treatment group.",
|
|
"tags": [
|
|
"Study Treatment Groups",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study treatment group.",
|
|
"tags": [
|
|
"Study Treatment Groups",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups({ID})/treatmentGroupSiteGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment group site groups of a study treatment group.",
|
|
"tags": [
|
|
"Study Treatment Groups",
|
|
"Treatment Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"plannedEnrollmentManualDF",
|
|
"plannedEnrollmentManualDF desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"actualEnrollment",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"plannedEnrollmentManualDF",
|
|
"enrollmentCurve_ID",
|
|
"treatmentGroup_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"treatmentGroup",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of TreatmentGroupSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentGroups({ID})/treatmentPeriods": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment periods of a study treatment group.",
|
|
"tags": [
|
|
"Study Treatment Groups",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"description",
|
|
"description desc",
|
|
"durationInDays",
|
|
"durationInDays desc",
|
|
"position",
|
|
"position desc",
|
|
"startDay",
|
|
"startDay desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"colorCode",
|
|
"colorCode desc",
|
|
"overage",
|
|
"overage desc",
|
|
"dropout",
|
|
"dropout desc",
|
|
"treatmentGroup_BK",
|
|
"treatmentGroup_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment periods.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentPeriods",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment periods.",
|
|
"tags": [
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"description",
|
|
"description desc",
|
|
"durationInDays",
|
|
"durationInDays desc",
|
|
"position",
|
|
"position desc",
|
|
"startDay",
|
|
"startDay desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"colorCode",
|
|
"colorCode desc",
|
|
"overage",
|
|
"overage desc",
|
|
"dropout",
|
|
"dropout desc",
|
|
"treatmentGroup_BK",
|
|
"treatmentGroup_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment periods.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentPeriods",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})/dispensationEvents": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of dispensation events of a study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods",
|
|
"Study Treatment Dispensation Events"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"dispensationEventID",
|
|
"dispensationEventID desc",
|
|
"description",
|
|
"description desc",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"dispensationEventID",
|
|
"description",
|
|
"treatmentPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentPeriod",
|
|
"treatmentAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved dispensation events.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentDispensationEvents",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})/switchFrom": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of subject switches from of a study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods",
|
|
"Study Treatment Switches"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"switchID",
|
|
"switchID desc",
|
|
"switchRate",
|
|
"switchRate desc",
|
|
"fromPeriod_BK",
|
|
"fromPeriod_BK desc",
|
|
"toPeriod_BK",
|
|
"toPeriod_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"fromTreatmentGroup_ID",
|
|
"fromTreatmentGroup_ID desc",
|
|
"toTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID desc",
|
|
"fromPeriod_ID",
|
|
"fromPeriod_ID desc",
|
|
"toPeriod_ID",
|
|
"toPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"switchID",
|
|
"switchRate",
|
|
"fromPeriod_BK",
|
|
"toPeriod_BK",
|
|
"treatmentSchedule_ID",
|
|
"fromTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID",
|
|
"fromPeriod_ID",
|
|
"toPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"fromTreatmentGroup",
|
|
"toTreatmentGroup",
|
|
"fromPeriod",
|
|
"toPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved switch from.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSwitches",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})/switchTo": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of switches-to of a study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods",
|
|
"Study Treatment Switches"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"switchID",
|
|
"switchID desc",
|
|
"switchRate",
|
|
"switchRate desc",
|
|
"fromPeriod_BK",
|
|
"fromPeriod_BK desc",
|
|
"toPeriod_BK",
|
|
"toPeriod_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"fromTreatmentGroup_ID",
|
|
"fromTreatmentGroup_ID desc",
|
|
"toTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID desc",
|
|
"fromPeriod_ID",
|
|
"fromPeriod_ID desc",
|
|
"toPeriod_ID",
|
|
"toPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"switchID",
|
|
"switchRate",
|
|
"fromPeriod_BK",
|
|
"toPeriod_BK",
|
|
"treatmentSchedule_ID",
|
|
"fromTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID",
|
|
"fromPeriod_ID",
|
|
"toPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"fromTreatmentGroup",
|
|
"toTreatmentGroup",
|
|
"fromPeriod",
|
|
"toPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved switch to.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSwitches",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})/treatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment group of a study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentPeriods({ID})/treatmentSchedule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentPeriods entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment schedule of a study treatment period.",
|
|
"tags": [
|
|
"Study Treatment Periods",
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleDeSyncTGs": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment schedule desynchronized treatment groups.",
|
|
"tags": [
|
|
"Study Treatment Schedule DeSyncTGs"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"treatmentGroup_BK",
|
|
"treatmentGroup_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment schedule desynchronized treatment groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentScheduleDeSyncTGs",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleDeSyncTGs({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentScheduleDeSyncTGs entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment scehdule desynchronized treatment group.",
|
|
"tags": [
|
|
"Study Treatment Schedule DeSyncTGs"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment scehdule desynchronized treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleDeSyncTGs({ID})/treatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentScheduleDeSyncTGs entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment group of a study treatment scehdule desynchronized treatment group.",
|
|
"tags": [
|
|
"Study Treatment Schedule DeSyncTGs",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleDeSyncTGs({ID})/treatmentSchedule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentScheduleDeSyncTGs entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment schedule of a study treatment scehdule desynchronized treatment group.",
|
|
"tags": [
|
|
"Study Treatment Schedule DeSyncTGs",
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleTreatments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment schedule treatments.",
|
|
"tags": [
|
|
"Study Treatment Schedule Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"schdule_ID",
|
|
"schdule_ID desc",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriod_ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"treatmentPeriod_description",
|
|
"treatmentPeriod_description desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"dispensationEventID",
|
|
"dispensationEventID desc",
|
|
"dispensationEvent_description",
|
|
"dispensationEvent_description desc",
|
|
"treatmentAssignment_ID",
|
|
"treatmentAssignment_ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"treatment_description",
|
|
"treatment_description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"schdule_ID",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriod_description",
|
|
"isDispensationPeriod",
|
|
"dispensationEvent_ID",
|
|
"dispensationEventID",
|
|
"dispensationEvent_description",
|
|
"treatmentAssignment_ID",
|
|
"treatmentID",
|
|
"treatment_description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment schedule treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentScheduleTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentScheduleTreatments({schdule_ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: schdule_ID",
|
|
"in": "path",
|
|
"name": "schdule_ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment schedule treatment.",
|
|
"tags": [
|
|
"Study Treatment Schedule Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"schdule_ID",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriod_description",
|
|
"isDispensationPeriod",
|
|
"dispensationEvent_ID",
|
|
"dispensationEventID",
|
|
"dispensationEvent_description",
|
|
"treatmentAssignment_ID",
|
|
"treatmentID",
|
|
"treatment_description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment schedule treatment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment schedules.",
|
|
"tags": [
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"randomizationGroup_ID",
|
|
"randomizationGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment schedules.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSchedules",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/assignedTreatments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of assigned treatments of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Study Treatment Schedule Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"schdule_ID",
|
|
"schdule_ID desc",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriod_ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"treatmentPeriod_description",
|
|
"treatmentPeriod_description desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"dispensationEvent_ID",
|
|
"dispensationEvent_ID desc",
|
|
"dispensationEventID",
|
|
"dispensationEventID desc",
|
|
"dispensationEvent_description",
|
|
"dispensationEvent_description desc",
|
|
"treatmentAssignment_ID",
|
|
"treatmentAssignment_ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"treatment_description",
|
|
"treatment_description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"schdule_ID",
|
|
"treatmentPeriod_ID",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriod_description",
|
|
"isDispensationPeriod",
|
|
"dispensationEvent_ID",
|
|
"dispensationEventID",
|
|
"dispensationEvent_description",
|
|
"treatmentAssignment_ID",
|
|
"treatmentID",
|
|
"treatment_description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved assigned treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentScheduleTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/desynchronizedTreatmentGroups": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of desynchronized treatment groups of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Study Treatment Schedule DeSyncTGs"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"isLastPeriodRepeatEnabled",
|
|
"isLastPeriodRepeatEnabled desc",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"weeksPriorToLastPeriodForRepeat desc",
|
|
"treatmentGroup_BK",
|
|
"treatmentGroup_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved desynchronized treatment groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentScheduleDeSyncTGs",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/randomizationGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve randomization group of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Randomization Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"randomizationGroupID",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"scenario_ID",
|
|
"ratioMode_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"ratioMode",
|
|
"randomizationGroupSiteGroups",
|
|
"treatmentGroups",
|
|
"treatmentSchedule"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved randomization group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/switches": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of switches of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Study Treatment Switches"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"switchID",
|
|
"switchID desc",
|
|
"switchRate",
|
|
"switchRate desc",
|
|
"fromPeriod_BK",
|
|
"fromPeriod_BK desc",
|
|
"toPeriod_BK",
|
|
"toPeriod_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"fromTreatmentGroup_ID",
|
|
"fromTreatmentGroup_ID desc",
|
|
"toTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID desc",
|
|
"fromPeriod_ID",
|
|
"fromPeriod_ID desc",
|
|
"toPeriod_ID",
|
|
"toPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"switchID",
|
|
"switchRate",
|
|
"fromPeriod_BK",
|
|
"toPeriod_BK",
|
|
"treatmentSchedule_ID",
|
|
"fromTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID",
|
|
"fromPeriod_ID",
|
|
"toPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"fromTreatmentGroup",
|
|
"toTreatmentGroup",
|
|
"fromPeriod",
|
|
"toPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved switches.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSwitches",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSchedules({ID})/treatmentPeriods": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSchedules entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment periods of a study treatment schedule.",
|
|
"tags": [
|
|
"Study Treatment Schedules",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentPeriodID",
|
|
"treatmentPeriodID desc",
|
|
"description",
|
|
"description desc",
|
|
"durationInDays",
|
|
"durationInDays desc",
|
|
"position",
|
|
"position desc",
|
|
"startDay",
|
|
"startDay desc",
|
|
"isDispensationPeriod",
|
|
"isDispensationPeriod desc",
|
|
"colorCode",
|
|
"colorCode desc",
|
|
"overage",
|
|
"overage desc",
|
|
"dropout",
|
|
"dropout desc",
|
|
"treatmentGroup_BK",
|
|
"treatmentGroup_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment periods.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentPeriods",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatment switches.",
|
|
"tags": [
|
|
"Study Treatment Switches"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"ID desc",
|
|
"switchID",
|
|
"switchID desc",
|
|
"switchRate",
|
|
"switchRate desc",
|
|
"fromPeriod_BK",
|
|
"fromPeriod_BK desc",
|
|
"toPeriod_BK",
|
|
"toPeriod_BK desc",
|
|
"treatmentSchedule_ID",
|
|
"treatmentSchedule_ID desc",
|
|
"fromTreatmentGroup_ID",
|
|
"fromTreatmentGroup_ID desc",
|
|
"toTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID desc",
|
|
"fromPeriod_ID",
|
|
"fromPeriod_ID desc",
|
|
"toPeriod_ID",
|
|
"toPeriod_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"switchID",
|
|
"switchRate",
|
|
"fromPeriod_BK",
|
|
"toPeriod_BK",
|
|
"treatmentSchedule_ID",
|
|
"fromTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID",
|
|
"fromPeriod_ID",
|
|
"toPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"fromTreatmentGroup",
|
|
"toTreatmentGroup",
|
|
"fromPeriod",
|
|
"toPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment switches.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatmentSwitches",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"switchID",
|
|
"switchRate",
|
|
"fromPeriod_BK",
|
|
"toPeriod_BK",
|
|
"treatmentSchedule_ID",
|
|
"fromTreatmentGroup_ID",
|
|
"toTreatmentGroup_ID",
|
|
"fromPeriod_ID",
|
|
"toPeriod_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"fromTreatmentGroup",
|
|
"toTreatmentGroup",
|
|
"fromPeriod",
|
|
"toPeriod"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment switch.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})/fromPeriod": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve from period of a study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved from period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})/fromTreatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve from treatment group of a study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved from treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})/toPeriod": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve to period of a study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches",
|
|
"Study Treatment Periods"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentPeriodID",
|
|
"description",
|
|
"durationInDays",
|
|
"position",
|
|
"startDay",
|
|
"isDispensationPeriod",
|
|
"colorCode",
|
|
"overage",
|
|
"dropout",
|
|
"treatmentGroup_BK",
|
|
"treatmentSchedule_ID",
|
|
"treatmentGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"treatmentSchedule",
|
|
"treatmentGroup",
|
|
"dispensationEvents",
|
|
"switchFrom",
|
|
"switchTo"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved to period.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})/toTreatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve to treatment group of a study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved to treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatmentSwitches({ID})/treatmentSchedule": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatmentSwitches entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment schedule of a study treatment switch.",
|
|
"tags": [
|
|
"Study Treatment Switches",
|
|
"Study Treatment Schedules"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID",
|
|
"siteGroupId",
|
|
"isLastPeriodRepeatEnabled",
|
|
"weeksPriorToLastPeriodForRepeat",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentPeriods",
|
|
"desynchronizedTreatmentGroups",
|
|
"assignedTreatments",
|
|
"switches"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment schedule.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatments": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study treatments.",
|
|
"tags": [
|
|
"Study Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"treatmentID",
|
|
"treatmentID desc",
|
|
"description",
|
|
"description desc",
|
|
"scenario_ID",
|
|
"scenario_ID desc",
|
|
"study_ID",
|
|
"study_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentID",
|
|
"description",
|
|
"scenario_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"study",
|
|
"kitTypeAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTreatments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatments({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study treatment.",
|
|
"tags": [
|
|
"Study Treatments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"treatmentID",
|
|
"description",
|
|
"scenario_ID",
|
|
"study_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"study",
|
|
"kitTypeAssignments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study treatment.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatments({ID})/kitTypeAssignments": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of kit type assignments of a study treatment.",
|
|
"tags": [
|
|
"Study Treatments",
|
|
"Kit Type Treatment Assignments"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"quantity",
|
|
"quantity desc",
|
|
"validFrom",
|
|
"validFrom desc",
|
|
"validTo",
|
|
"validTo desc",
|
|
"study_ID",
|
|
"study_ID desc",
|
|
"kitType_ID",
|
|
"kitType_ID desc",
|
|
"kitType_BK",
|
|
"kitType_BK desc",
|
|
"treatment_ID",
|
|
"treatment_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"quantity",
|
|
"validFrom",
|
|
"validTo",
|
|
"study_ID",
|
|
"kitType_ID",
|
|
"kitType_BK",
|
|
"treatment_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"kitType",
|
|
"treatment"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved kit type assignments.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of KitTypeTreatmentAssignments",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatments({ID})/scenario": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario of a study treatment.",
|
|
"tags": [
|
|
"Study Treatments",
|
|
"Scenarios"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"scenarioID",
|
|
"scenario_num",
|
|
"study_ID",
|
|
"description",
|
|
"detailedDescription",
|
|
"statusChangedAt",
|
|
"ctmProtocolUpdate",
|
|
"copiedFrom",
|
|
"hasECManualToAutoChange",
|
|
"status_code"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"study",
|
|
"status",
|
|
"scenarioSiteGroups",
|
|
"randomizationGroups",
|
|
"treatments",
|
|
"timelineSchedules",
|
|
"consolidatedSiteGroups",
|
|
"demandForecast",
|
|
"externalEnrollments"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTreatments({ID})/study": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of StudyTreatments entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve study of a study treatment.",
|
|
"tags": [
|
|
"Study Treatments",
|
|
"Studies"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"CTSMStudyID",
|
|
"CTSMProtocolID",
|
|
"description",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectLastVisit",
|
|
"pushedToSupplyPlanningOn",
|
|
"pushedToSupplyPlanningBy",
|
|
"isSiteLevelTracking",
|
|
"eudraCT",
|
|
"hasKitTypeSpecificDepots",
|
|
"openLabel",
|
|
"isLeanStudy",
|
|
"isMultiprotocol",
|
|
"isTGwithOffsets",
|
|
"actualManagement",
|
|
"planningHorizonStart",
|
|
"planningHorizonEnd",
|
|
"sponsor_personNumber",
|
|
"isLinkedCTMS",
|
|
"status_code",
|
|
"studyType_ID",
|
|
"studyPhase_ID",
|
|
"leadMolecule_ID",
|
|
"therapeuticArea_ID",
|
|
"distrTemplateId_ID",
|
|
"blindingScenario_ID",
|
|
"costObject_ID",
|
|
"costObject_type"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"contacts",
|
|
"materials",
|
|
"blindingGroups",
|
|
"siteGroups",
|
|
"status",
|
|
"studyType",
|
|
"studyPhase",
|
|
"leadMolecule",
|
|
"therapeuticArea",
|
|
"distrTemplateId",
|
|
"blindingScenario",
|
|
"costObject",
|
|
"scenarios",
|
|
"kitTypes",
|
|
"externalIdentifiers",
|
|
"actualsSourceSetting",
|
|
"protocols",
|
|
"externalEnrollments",
|
|
"labelGroups",
|
|
"kitTypeTrees",
|
|
"demand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study types.",
|
|
"tags": [
|
|
"Study Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"sort_num",
|
|
"sort_num desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc",
|
|
"isObsolete",
|
|
"isObsolete desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study types.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTypes",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study type.",
|
|
"tags": [
|
|
"Study Types"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study type.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a study type.",
|
|
"tags": [
|
|
"Study Types",
|
|
"Study Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a study type.",
|
|
"tags": [
|
|
"Study Types",
|
|
"Study Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTypes_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of study types_texts.",
|
|
"tags": [
|
|
"Study Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"description",
|
|
"description desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study types_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of StudyTypes_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/StudyTypes_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single study types_text.",
|
|
"tags": [
|
|
"Study Types texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"description"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved study types_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas": {
|
|
"get": {
|
|
"summary": "Retrieve a list of therapeutic areas.",
|
|
"tags": [
|
|
"Therapeutic Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"sort_num",
|
|
"sort_num desc",
|
|
"ID",
|
|
"ID desc",
|
|
"therapeuticAreaDescription",
|
|
"therapeuticAreaDescription desc",
|
|
"isObsolete",
|
|
"isObsolete desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"therapeuticAreaDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved therapeutic areas.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of TherapeuticAreas",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas('{ID}')": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single therapeutic area.",
|
|
"tags": [
|
|
"Therapeutic Areas"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"sort_num",
|
|
"ID",
|
|
"therapeuticAreaDescription",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved therapeutic area.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas('{ID}')/localized": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a localized description of a therapeutic area.",
|
|
"tags": [
|
|
"Therapeutic Areas",
|
|
"Therapeutic Areas texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"therapeuticAreaDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved localized description.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas('{ID}')/texts": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a list of localized descriptions of a therapeutic area.",
|
|
"tags": [
|
|
"Therapeutic Areas",
|
|
"Therapeutic Areas texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"therapeuticAreaDescription",
|
|
"therapeuticAreaDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"therapeuticAreaDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of TherapeuticAreas_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas_texts": {
|
|
"get": {
|
|
"summary": "Retrieve a list of therapeutic areas_texts.",
|
|
"tags": [
|
|
"Therapeutic Areas texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"ID_texts desc",
|
|
"locale",
|
|
"locale desc",
|
|
"ID",
|
|
"ID desc",
|
|
"therapeuticAreaDescription",
|
|
"therapeuticAreaDescription desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"therapeuticAreaDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved therapeutic areas_texts.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of TherapeuticAreas_texts",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TherapeuticAreas_texts({ID_texts})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID_texts",
|
|
"in": "path",
|
|
"name": "ID_texts",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single therapeutic areas_text.",
|
|
"tags": [
|
|
"Therapeutic Areas texts"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"ID_texts",
|
|
"locale",
|
|
"ID",
|
|
"therapeuticAreaDescription"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved therapeutic areas_text.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TreatmentGroupSiteGroups": {
|
|
"get": {
|
|
"summary": "Retrieve a list of treatment group site groups.",
|
|
"tags": [
|
|
"Treatment Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"$ref": "#/components/parameters/top"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/skip"
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/search"
|
|
},
|
|
{
|
|
"name": "$filter",
|
|
"description": "Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)",
|
|
"in": "query",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
},
|
|
{
|
|
"$ref": "#/components/parameters/count"
|
|
},
|
|
{
|
|
"name": "$orderby",
|
|
"description": "Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdAt desc",
|
|
"createdBy",
|
|
"createdBy desc",
|
|
"modifiedAt",
|
|
"modifiedAt desc",
|
|
"modifiedBy",
|
|
"modifiedBy desc",
|
|
"ID",
|
|
"ID desc",
|
|
"active",
|
|
"active desc",
|
|
"regulatoryApproval",
|
|
"regulatoryApproval desc",
|
|
"firstSubjectFirstVisit",
|
|
"firstSubjectFirstVisit desc",
|
|
"lastSubjectFirstVisit",
|
|
"lastSubjectFirstVisit desc",
|
|
"plannedEnrollment",
|
|
"plannedEnrollment desc",
|
|
"plannedNumberOfSites",
|
|
"plannedNumberOfSites desc",
|
|
"actualEnrollment",
|
|
"actualEnrollment desc",
|
|
"manualEnrollment",
|
|
"manualEnrollment desc",
|
|
"siteGroupId",
|
|
"siteGroupId desc",
|
|
"plannedEnrollmentManualDF",
|
|
"plannedEnrollmentManualDF desc",
|
|
"enrollmentCurve_ID",
|
|
"enrollmentCurve_ID desc",
|
|
"treatmentGroup_ID",
|
|
"treatmentGroup_ID desc",
|
|
"scenarioSiteGroup_ID",
|
|
"scenarioSiteGroup_ID desc"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"actualEnrollment",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"plannedEnrollmentManualDF",
|
|
"enrollmentCurve_ID",
|
|
"treatmentGroup_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"treatmentGroup",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group site groups.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"title": "Collection of TreatmentGroupSiteGroups",
|
|
"properties": {
|
|
"@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"value": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TreatmentGroupSiteGroups({ID})": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of TreatmentGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve a single treatment group site group.",
|
|
"tags": [
|
|
"Treatment Group Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"plannedEnrollment",
|
|
"plannedNumberOfSites",
|
|
"actualEnrollment",
|
|
"manualEnrollment",
|
|
"siteGroupId",
|
|
"plannedEnrollmentManualDF",
|
|
"enrollmentCurve_ID",
|
|
"treatmentGroup_ID",
|
|
"scenarioSiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"enrollmentCurve",
|
|
"treatmentGroup",
|
|
"scenarioSiteGroup"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TreatmentGroupSiteGroups({ID})/enrollmentCurve": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of TreatmentGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve enrollment curve of a treatment group site group.",
|
|
"tags": [
|
|
"Treatment Group Site Groups",
|
|
"Enrollment Curves"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"businessKey",
|
|
"enrollmentCurveName",
|
|
"description",
|
|
"isObsolete"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"dataPoints",
|
|
"connectedStudies",
|
|
"texts",
|
|
"localized"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved enrollment curve.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TreatmentGroupSiteGroups({ID})/scenarioSiteGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of TreatmentGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve scenario site group of a treatment group site group.",
|
|
"tags": [
|
|
"Treatment Group Site Groups",
|
|
"Study Scenario Site Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"active",
|
|
"regulatoryApproval",
|
|
"firstSubjectFirstVisit",
|
|
"lastSubjectFirstVisit",
|
|
"manualEnrollment",
|
|
"plannedEnrollment",
|
|
"actualEnrollment",
|
|
"plannedNumberOfSites",
|
|
"activatedSites",
|
|
"siteGroupId",
|
|
"scenario_ID",
|
|
"studySiteGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"studySiteGroup",
|
|
"scenarioSiteSeeding",
|
|
"scenarioAdditionalDemand"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved scenario site group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/TreatmentGroupSiteGroups({ID})/treatmentGroup": {
|
|
"parameters": [
|
|
{
|
|
"description": "Key: ID (UUID) of TreatmentGroupSiteGroups entity.",
|
|
"in": "path",
|
|
"name": "ID",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
}
|
|
],
|
|
"get": {
|
|
"summary": "Retrieve treatment group of a treatment group site group.",
|
|
"tags": [
|
|
"Treatment Group Site Groups",
|
|
"Study Treatment Groups"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "$select",
|
|
"description": "Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"createdAt",
|
|
"createdBy",
|
|
"modifiedAt",
|
|
"modifiedBy",
|
|
"ID",
|
|
"studyTreatmentGroupID",
|
|
"offset",
|
|
"offsetUnit",
|
|
"position",
|
|
"description",
|
|
"plannedEnrollment",
|
|
"ratioPercent",
|
|
"ratioAbsolute",
|
|
"scenario_ID",
|
|
"randomizationGroup_ID"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
{
|
|
"name": "$expand",
|
|
"description": "Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)",
|
|
"in": "query",
|
|
"explode": false,
|
|
"schema": {
|
|
"type": "array",
|
|
"uniqueItems": true,
|
|
"items": {
|
|
"type": "string",
|
|
"enum": [
|
|
"*",
|
|
"scenario",
|
|
"randomizationGroup",
|
|
"treatmentGroupSiteGroups",
|
|
"treatmentPeriods"
|
|
]
|
|
}
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Retrieved treatment group.",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"/deleteExternalEnrollments": {
|
|
"post": {
|
|
"summary": "Invoke action deleteExternalEnrollments. Body should either have studyID or studyUUID or protocolID",
|
|
"tags": [
|
|
"Service Operations"
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"401": {
|
|
"$ref": "#/components/responses/401"
|
|
},
|
|
"403": {
|
|
"$ref": "#/components/responses/403"
|
|
},
|
|
"404": {
|
|
"$ref": "#/components/responses/404"
|
|
},
|
|
"500": {
|
|
"$ref": "#/components/responses/500"
|
|
}
|
|
},
|
|
"requestBody": {
|
|
"description": "Action parameters",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"type": "object",
|
|
"properties": {
|
|
"studyUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studyID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"security": [
|
|
{
|
|
"OAuth2": [
|
|
"studiesapiread"
|
|
]
|
|
}
|
|
],
|
|
"components": {
|
|
"securitySchemes": {
|
|
"OAuth2": {
|
|
"type": "oauth2",
|
|
"flows": {
|
|
"clientCredentials": {
|
|
"tokenUrl": "https://{subdomain(identity_zone)}.authentication.eu10.hana.ondemand.com/oauth/token",
|
|
"scopes": {}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"schemas": {
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups": {
|
|
"title": "Blinding Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Management environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Management environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"blindingGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"blindingGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"blindedDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups-create": {
|
|
"title": "Blinding Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"blindingGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"blindingGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"blindedDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios": {
|
|
"title": "Blinding Scenarios",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Management environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Management environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"blindingStrategyDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios-create": {
|
|
"title": "Blinding Scenarios (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"blindingStrategyDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts": {
|
|
"title": "Blinding Scenarios texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"blindingStrategyDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios_texts-create": {
|
|
"title": "Blinding Scenarios texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"blindingStrategyDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates": {
|
|
"title": "Cached Distributing Templates",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates-create": {
|
|
"title": "Cached Distributing Templates (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas": {
|
|
"title": "Cached MRP Areas",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"mrpAreaText": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create": {
|
|
"title": "Cached M R P Areas (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"mrpAreaText": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules": {
|
|
"title": "Cached Molecules",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"MoleculeId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"Description": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules-create": {
|
|
"title": "Cached Molecules (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"MoleculeId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"Description": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"MoleculeUUID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems": {
|
|
"title": "Cached Ref Kit Type Items",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"MoleculeId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"Molecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems-create": {
|
|
"title": "Cached Ref Kit Type Items (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"MoleculeId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"Molecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"MoleculeUUID",
|
|
"RefKitTypeUUID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes": {
|
|
"title": "Cached Ref Kit Types",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"RefKitID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"INNDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"KitTypeItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems"
|
|
}
|
|
},
|
|
"KitTypeItems@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes-create": {
|
|
"title": "Cached Ref Kit Types (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"RefKitID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"INNDescription": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"KitTypeItems": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypeItems-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"RefKitTypeUUID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups": {
|
|
"title": "Cached Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"materialPooling": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create": {
|
|
"title": "Cached Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"materialPooling": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts": {
|
|
"title": "Cached Site Groups texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups_texts-create": {
|
|
"title": "Cached Site Groups texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups": {
|
|
"title": "Consolidated Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectLastVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"actualEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"activatedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isLinkedCTMS": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isStudyCompleted": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"ctmsPlannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ctmsFirstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"ctmsLastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"ctmsPlannedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ctmsActualSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups-create": {
|
|
"title": "Consolidated Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectLastVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"actualEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"activatedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isLinkedCTMS": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isStudyCompleted": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"ctmsPlannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ctmsFirstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"ctmsLastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"ctmsPlannedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ctmsActualSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles": {
|
|
"title": "Contact Roles",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Management environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Management environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"roleName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles-create": {
|
|
"title": "Contact Roles (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"roleName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts": {
|
|
"title": "Contact Roles texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"roleName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles_texts-create": {
|
|
"title": "Contact Roles texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"roleName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts": {
|
|
"title": "Contacts",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Management environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Management environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Management environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"parentID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"maxLength": 241,
|
|
"nullable": true
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"cachedPerson_personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"userSource": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"role": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"role_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"person": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts-create": {
|
|
"title": "Contacts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"parentID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"maxLength": 241,
|
|
"nullable": true
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"cachedPerson_personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"userSource": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"role": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ContactRoles-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"role_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"person": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject": {
|
|
"title": "Cost Object",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"typeText": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject-create": {
|
|
"title": "Cost Object (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"typeText": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID",
|
|
"type"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes": {
|
|
"title": "Cost Object Types",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes-create": {
|
|
"title": "Cost Object Types (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts": {
|
|
"title": "Cost Object Types texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObjectTypes_texts-create": {
|
|
"title": "Cost Object Types texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts": {
|
|
"title": "Cost Object texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject_texts-create": {
|
|
"title": "Cost Object texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 24
|
|
},
|
|
"type": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"ID",
|
|
"type"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country": {
|
|
"title": "Country",
|
|
"type": "object",
|
|
"properties": {
|
|
"refreshedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
},
|
|
"countryName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"daysOffset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country-create": {
|
|
"title": "Country (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
},
|
|
"countryName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
},
|
|
"daysOffset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"countryId"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts": {
|
|
"title": "Country texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
},
|
|
"countryName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country_texts-create": {
|
|
"title": "Country texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3
|
|
},
|
|
"countryName": {
|
|
"type": "string",
|
|
"maxLength": 50,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"countryId"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand": {
|
|
"title": "Demand Forecast Demand",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"planningFigureType": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.00001,
|
|
"maximum": 9999999999.99999,
|
|
"minimum": -9999999999.99999,
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 250,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 250,
|
|
"nullable": true
|
|
},
|
|
"visitPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"maxLength": 250,
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"mrpArea": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand-create": {
|
|
"title": "Demand Forecast Demand (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.00001,
|
|
"maximum": 9999999999.99999,
|
|
"minimum": -9999999999.99999,
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"mrpArea": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment": {
|
|
"title": "Demand Forecast Enrollment",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"planningFigureType": {
|
|
"type": "string",
|
|
"maxLength": 15,
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "double",
|
|
"example": 3.14,
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment-create": {
|
|
"title": "Demand Forecast Enrollment (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"planningFigureType": {
|
|
"type": "string",
|
|
"maxLength": 15,
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "double",
|
|
"example": 3.14,
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses": {
|
|
"title": "Demand Forecast Site Group Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses-create": {
|
|
"title": "Demand Forecast Site Group Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts": {
|
|
"title": "Demand Forecast Site Group Statuses texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses_texts-create": {
|
|
"title": "Demand Forecast Site Group Statuses texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits": {
|
|
"title": "Demand Forecast Visits",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"planningFigureType": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "double",
|
|
"example": 3.14,
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"visitPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits-create": {
|
|
"title": "Demand Forecast Visits (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"planningFigureValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "double",
|
|
"example": 3.14,
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionNumerator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"planningFigureFractionDenominator": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"calendarWeek": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"calendarWeekDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"visitPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"demandForecast_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"planningFigureDescription": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts": {
|
|
"title": "Demand Forecasts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"enrollment": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment"
|
|
}
|
|
},
|
|
"enrollment@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"visits": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits"
|
|
}
|
|
},
|
|
"visits@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand"
|
|
}
|
|
},
|
|
"demand@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts-create": {
|
|
"title": "Demand Forecasts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"enrollment": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastEnrollment-create"
|
|
}
|
|
},
|
|
"visits": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastVisits-create"
|
|
}
|
|
},
|
|
"demand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastDemand-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves": {
|
|
"title": "Enrollment Curves",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Management environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"businessKey": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"enrollmentCurveName": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"dataPoints": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints"
|
|
}
|
|
},
|
|
"dataPoints@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"connectedStudies": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves"
|
|
}
|
|
},
|
|
"connectedStudies@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves-create": {
|
|
"title": "Enrollment Curves (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"businessKey": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"enrollmentCurveName": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"dataPoints": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints-create"
|
|
}
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"connectedStudies": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves-create"
|
|
}
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts": {
|
|
"title": "Enrollment Curves texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves_texts-create": {
|
|
"title": "Enrollment Curves texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints": {
|
|
"title": "Enrollment Data Points",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"enrollmentPeriodPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"patientsEnrolledPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dataPoints_fc": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentDataPoints-create": {
|
|
"title": "Enrollment Data Points (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"enrollmentPeriodPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"patientsEnrolledPercentage": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dataPoints_fc": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries": {
|
|
"title": "External Enrollment Time Series",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"enrollmentDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
},
|
|
"enrollmentWeekDate": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"enrollmentValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.00001,
|
|
"maximum": 9999999999.99999,
|
|
"minimum": -9999999999.99999,
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studyUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-create": {
|
|
"title": "External Enrollment Time Series (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"enrollmentDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
},
|
|
"enrollmentWeekDate": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"example": "2017-W15"
|
|
},
|
|
"enrollmentValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.00001,
|
|
"maximum": 9999999999.99999,
|
|
"minimum": -9999999999.99999,
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"randomizationGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"siteGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
"required": [
|
|
"enrollmentValue"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-update": {
|
|
"title": "External Enrollment Time Series (for update)",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"enrollmentDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
},
|
|
"enrollmentWeekDate": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true,
|
|
"example": "2017-W15"
|
|
},
|
|
"enrollmentValue": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.00001,
|
|
"maximum": 9999999999.99999,
|
|
"minimum": -9999999999.99999
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"randomizationGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"siteGroupUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
}
|
|
},
|
|
"required": [
|
|
"enrollmentValue"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers": {
|
|
"title": "External Identifiers",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isVisible": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers-create": {
|
|
"title": "External Identifiers (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"name": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isVisible": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement": {
|
|
"title": "Kit Type Country Label Group Element",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string"
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"labelGroupID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"labelGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isPast": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement-create": {
|
|
"title": "Kit Type Country Label Group Element (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string"
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"labelGroupID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"labelGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"isPast": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses": {
|
|
"title": "Kit Type Country Regulatory Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeMaterialLabelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitTypeMaterialLabelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"countryID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"regulatoryStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"regulatoryStatus_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 4
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses-create": {
|
|
"title": "Kit Type Country Regulatory Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeMaterialLabelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitTypeMaterialLabelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"countryID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"regulatoryStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"regulatoryStatus_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 4
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments": {
|
|
"title": "Kit Type Label Group Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"labelGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelMaterialAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
},
|
|
"labelMaterialAssignments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments-create": {
|
|
"title": "Kit Type Label Group Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"labelGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelMaterialAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments": {
|
|
"title": "Kit Type Material Label Group Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"labelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeCountryRegulatoryStatuses": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses"
|
|
}
|
|
},
|
|
"kitTypeCountryRegulatoryStatuses@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments-create": {
|
|
"title": "Kit Type Material Label Group Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"labelGroupAssignment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroupAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeCountryRegulatoryStatuses": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryRegulatoryStatuses-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules": {
|
|
"title": "Kit Type Molecules",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"molecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"molecule_MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules-create": {
|
|
"title": "Kit Type Molecules (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"molecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMolecules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"molecule_MoleculeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots": {
|
|
"title": "Kit Type Site Group Depots",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"depotBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"shipLeadTime": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"siteBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"centralDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"centralDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"distrDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots-create": {
|
|
"title": "Kit Type Site Group Depots (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"depotBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"shipLeadTime": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"siteBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"centralDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"centralDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"distrDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments": {
|
|
"title": "Kit Type Treatment Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments-create": {
|
|
"title": "Kit Type Treatment Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement": {
|
|
"title": "Kit Type Tree Element",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string"
|
|
},
|
|
"nodeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"hierarchyLevel": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"external_UUID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"externalDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"parentNodeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"drillState": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"distributingTemplate_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"distributingTemplateDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"businessID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"countryID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"countryAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"adminType": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteAdminPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"serialization": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitTypePosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"labelGroupPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"HasActiveEntity": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement-create": {
|
|
"title": "Kit Type Tree Element (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string"
|
|
},
|
|
"nodeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"hierarchyLevel": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"external_UUID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"externalDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"parentNodeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"drillState": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"distributingTemplate_ID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"distributingTemplateDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"businessID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"countryID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"countryAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"adminType": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteAdminPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"serialization": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitTypePosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"labelGroupPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"HasActiveEntity": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes": {
|
|
"title": "Kit Types",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"adminType": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteAdminPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"serialization": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"distrTemplateId": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId_ID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"refKitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"refKitType_RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeMolecules": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules"
|
|
}
|
|
},
|
|
"kitTypeMolecules@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"labelGroupAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments"
|
|
}
|
|
},
|
|
"labelGroupAssignments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"countrySiteGroupDepots": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
},
|
|
"countrySiteGroupDepots@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"countryLabelGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement"
|
|
}
|
|
},
|
|
"countryLabelGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"countryMaterials": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments"
|
|
}
|
|
},
|
|
"countryMaterials@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create": {
|
|
"title": "Kit Types (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 200,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"adminType": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteAdminPeriod": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"serialization": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"blindingGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"distrTemplateId": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId_ID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"refKitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedRefKitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"refKitType_RefKitTypeUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeMolecules": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMolecules-create"
|
|
}
|
|
},
|
|
"labelGroupAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeLabelGroupAssignments-create"
|
|
}
|
|
},
|
|
"countrySiteGroupDepots": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots-create"
|
|
}
|
|
},
|
|
"countryLabelGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeCountryLabelGroupElement-create"
|
|
}
|
|
},
|
|
"countryMaterials": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeMaterialLabelGroupAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments": {
|
|
"title": "Label Group Country Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments-create": {
|
|
"title": "Label Group Country Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"labelGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"country": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Country-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"country_countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups": {
|
|
"title": "Label Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"labelGroupID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"labelGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroupCountryAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments"
|
|
}
|
|
},
|
|
"labelGroupCountryAssignments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups-create": {
|
|
"title": "Label Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"labelGroupID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"labelGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"labelGroupCountryAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroupCountryAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules": {
|
|
"title": "Lead Molecules",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"externalID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sourceSystem": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules-create": {
|
|
"title": "Lead Molecules (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"externalID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"sourceSystem": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts": {
|
|
"title": "Lead Molecules texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts-create": {
|
|
"title": "Lead Molecules texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues": {
|
|
"title": "Lean Study Demand Bucket Values",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"leanStudyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues-create": {
|
|
"title": "Lean Study Demand Bucket Values (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"leanStudyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets": {
|
|
"title": "Lean Study Demand Buckets",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets-create": {
|
|
"title": "Lean Study Demand Buckets (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13"
|
|
}
|
|
},
|
|
"required": [
|
|
"studyDemandUUID",
|
|
"dateValue"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands": {
|
|
"title": "Lean Study Demands",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kittype_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands-create": {
|
|
"title": "Lean Study Demands (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kittype_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation": {
|
|
"title": "Lean Study Demands Presentation",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"dummy": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"dummyExpands": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"leanStudyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"bucketValues": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues"
|
|
}
|
|
},
|
|
"bucketValues@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation-create": {
|
|
"title": "Lean Study Demands Presentation (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyDemand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyDemand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"depot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"depot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"kittype": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kittype_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"doNotShip": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"dateValue": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"demandValue": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"leanStudyDemandUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"depotDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"materialDescription": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"bucketValues": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBucketValues-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses": {
|
|
"title": "Lean Study Schedule Agreement Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses-create": {
|
|
"title": "Lean Study Schedule Agreement Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts": {
|
|
"title": "Lean Study Schedule Agreement Statuses texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses_texts-create": {
|
|
"title": "Lean Study Schedule Agreement Statuses texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 500,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups": {
|
|
"title": "Lean Study Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"demand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"demand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"pushedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"pushedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"pushStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"pushStatusDescription": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"interimStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"pushedScheAgrCount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"pushEpoch": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"successPushOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"successPushBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"documentNumber": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true
|
|
},
|
|
"documentStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"documentStatusDescription": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"logEntries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries"
|
|
}
|
|
},
|
|
"logEntries@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"isKitTypeSpecific": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitTypeSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"protocolIDLabel": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups-create": {
|
|
"title": "Lean Study Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"demand": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"demand_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"pushedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"pushedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"pushStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"pushStatusDescription": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecastSiteGroupStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"interimStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"pushedScheAgrCount": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"pushEpoch": {
|
|
"anyOf": [
|
|
{
|
|
"type": "integer"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "int64",
|
|
"example": "42",
|
|
"nullable": true
|
|
},
|
|
"successPushOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"successPushBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"documentStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"documentStatusDescription": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyScheduleAgreementStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"logEntries": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries-create"
|
|
}
|
|
},
|
|
"isKitTypeSpecific": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeSiteGroupDepots-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitTypeSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"protocol": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocol_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"isActive": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Materials": {
|
|
"title": "Materials",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"baseUnit": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"numberOfDecimals": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Materials-create": {
|
|
"title": "Materials (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"baseUnit": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"numberOfDecimals": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView": {
|
|
"title": "Materials View",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"baseUnit": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"numberOfDecimals": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"crossStudy": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"category": {
|
|
"type": "string",
|
|
"maxLength": 2,
|
|
"nullable": true
|
|
},
|
|
"materialTypeName": {
|
|
"type": "string",
|
|
"maxLength": 25,
|
|
"nullable": true
|
|
},
|
|
"source": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView-create": {
|
|
"title": "Materials View (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"materialID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"baseUnit": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"numberOfDecimals": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"crossStudy": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"category": {
|
|
"type": "string",
|
|
"maxLength": 2,
|
|
"nullable": true
|
|
},
|
|
"materialTypeName": {
|
|
"type": "string",
|
|
"maxLength": 25,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons": {
|
|
"title": "Persons",
|
|
"type": "object",
|
|
"properties": {
|
|
"personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"userSource": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"maxLength": 241,
|
|
"nullable": true
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Persons-create": {
|
|
"title": "Persons (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40
|
|
},
|
|
"userSource": {
|
|
"type": "integer",
|
|
"format": "int32"
|
|
},
|
|
"firstName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"lastName": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"email": {
|
|
"type": "string",
|
|
"maxLength": 241,
|
|
"nullable": true
|
|
},
|
|
"phoneNumber": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"personNumber",
|
|
"userSource"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries": {
|
|
"title": "Push To S P Log Entries",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"messageType": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable1": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable2": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable3": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable4": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"entryOrder": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.PushToSPLogEntries-create": {
|
|
"title": "Push To S P Log Entries (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"messageType": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"variable1": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable2": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable3": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"variable4": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"entryOrder": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups": {
|
|
"title": "Randomization Group Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupId": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"recalculatedLSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"participatesInCompetitiveEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"competitiveEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"recalculationMethod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"recalculationMethod_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
},
|
|
"enrollmentRecalculationMethodFallbackUsed": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentRecalculationMethodFallbackUsed_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups-create": {
|
|
"title": "Randomization Group Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupId": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"recalculatedLSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"participatesInCompetitiveEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"competitiveEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"recalculationMethod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"recalculationMethod_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
},
|
|
"enrollmentRecalculationMethodFallbackUsed": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentRecalculationMethodFallbackUsed_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 3
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups": {
|
|
"title": "Randomization Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"ratioMode": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"ratioMode_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"randomizationGroupSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups"
|
|
}
|
|
},
|
|
"randomizationGroupSiteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"treatmentGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
},
|
|
"treatmentGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"treatmentSchedule": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
},
|
|
"treatmentSchedule@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create": {
|
|
"title": "Randomization Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"ratioMode": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"ratioMode_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"randomizationGroupSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroupSiteGroups-create"
|
|
}
|
|
},
|
|
"treatmentGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
},
|
|
"treatmentSchedule": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode": {
|
|
"title": "Ratio Mode",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode-create": {
|
|
"title": "Ratio Mode (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts": {
|
|
"title": "Ratio Mode texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RatioMode_texts-create": {
|
|
"title": "Ratio Mode texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod": {
|
|
"title": "Recalculation Method",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod-create": {
|
|
"title": "Recalculation Method (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed": {
|
|
"title": "Recalculation Method Fallback Used",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed-create": {
|
|
"title": "Recalculation Method Fallback Used (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts": {
|
|
"title": "Recalculation Method Fallback Used texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethodFallbackUsed_texts-create": {
|
|
"title": "Recalculation Method Fallback Used texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts": {
|
|
"title": "Recalculation Method texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RecalculationMethod_texts-create": {
|
|
"title": "Recalculation Method texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 3
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios": {
|
|
"title": "Scenarios",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"scenario_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"detailedDescription": {
|
|
"type": "string",
|
|
"maxLength": 2000,
|
|
"nullable": true
|
|
},
|
|
"statusChangedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"ctmProtocolUpdate": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"copiedFrom": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"hasECManualToAutoChange": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"scenarioSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
},
|
|
"scenarioSiteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"randomizationGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
},
|
|
"randomizationGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"treatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
},
|
|
"treatments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"timelineSchedules": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules"
|
|
}
|
|
},
|
|
"timelineSchedules@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"consolidatedSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups"
|
|
}
|
|
},
|
|
"consolidatedSiteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demandForecast": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"externalEnrollments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
},
|
|
"externalEnrollments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create": {
|
|
"title": "Scenarios (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"scenario_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"detailedDescription": {
|
|
"type": "string",
|
|
"maxLength": 2000,
|
|
"nullable": true
|
|
},
|
|
"statusChangedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"ctmProtocolUpdate": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"copiedFrom": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"hasECManualToAutoChange": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status_code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"scenarioSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
},
|
|
"randomizationGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
},
|
|
"treatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments-create"
|
|
}
|
|
},
|
|
"timelineSchedules": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules-create"
|
|
}
|
|
},
|
|
"consolidatedSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ConsolidatedSiteGroups-create"
|
|
}
|
|
},
|
|
"demandForecast": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.DemandForecasts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"externalEnrollments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups": {
|
|
"title": "Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"depotBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"shipLeadTime": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"centralDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"centralDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"distrDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create": {
|
|
"title": "Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"depotBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"shipLeadTime": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteBuffer": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"countryId": {
|
|
"type": "string",
|
|
"maxLength": 3,
|
|
"nullable": true
|
|
},
|
|
"siteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"siteGroup_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"centralDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"centralDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"distrDepot": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedMRPAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrDepot_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies": {
|
|
"title": "Studies",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"CTSMStudyID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"CTSMProtocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectLastVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"pushedToSupplyPlanningOn": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"pushedToSupplyPlanningBy": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isSiteLevelTracking": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"eudraCT": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"hasKitTypeSpecificDepots": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"openLabel": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isLeanStudy": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isMultiprotocol": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isTGwithOffsets": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"actualManagement": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 2
|
|
},
|
|
"planningHorizonStart": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"planningHorizonEnd": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"sponsor_personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"isLinkedCTMS": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"contacts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts"
|
|
}
|
|
},
|
|
"contacts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"materials": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials"
|
|
}
|
|
},
|
|
"materials@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"blindingGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups"
|
|
}
|
|
},
|
|
"blindingGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"siteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
},
|
|
"siteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"status": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studyType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyType_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"studyPhase": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyPhase_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"leadMolecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"leadMolecule_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"therapeuticArea": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"therapeuticArea_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId_ID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"blindingScenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"blindingScenario_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"costObject": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"costObject_ID": {
|
|
"type": "string",
|
|
"maxLength": 24,
|
|
"nullable": true
|
|
},
|
|
"costObject_type": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"scenarios": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
},
|
|
"scenarios@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"kitTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
},
|
|
"kitTypes@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"externalIdentifiers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments"
|
|
}
|
|
},
|
|
"externalIdentifiers@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"actualsSourceSetting": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocols": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols"
|
|
}
|
|
},
|
|
"protocols@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"externalEnrollments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries"
|
|
}
|
|
},
|
|
"externalEnrollments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"labelGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups"
|
|
}
|
|
},
|
|
"labelGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"kitTypeTrees": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement"
|
|
}
|
|
},
|
|
"kitTypeTrees@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands"
|
|
}
|
|
},
|
|
"demand@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create": {
|
|
"title": "Studies (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"CTSMStudyID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"CTSMProtocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectLastVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"pushedToSupplyPlanningOn": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"pushedToSupplyPlanningBy": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isSiteLevelTracking": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"eudraCT": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"hasKitTypeSpecificDepots": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"openLabel": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isLeanStudy": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isMultiprotocol": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"isTGwithOffsets": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"actualManagement": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 2
|
|
},
|
|
"planningHorizonStart": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"planningHorizonEnd": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"sponsor_personNumber": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"isLinkedCTMS": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"contacts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Contacts-create"
|
|
}
|
|
},
|
|
"materials": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials-create"
|
|
}
|
|
},
|
|
"blindingGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingGroups-create"
|
|
}
|
|
},
|
|
"siteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
},
|
|
"status": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"status_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studyType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyType_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"studyPhase": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studyPhase_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"leadMolecule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"leadMolecule_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"therapeuticArea": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"therapeuticArea_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CachedDistributingTemplates-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"distrTemplateId_ID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"blindingScenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.BlindingScenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"blindingScenario_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"costObject": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.CostObject-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"costObject_ID": {
|
|
"type": "string",
|
|
"maxLength": 24,
|
|
"nullable": true
|
|
},
|
|
"costObject_type": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"scenarios": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
},
|
|
"kitTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
},
|
|
"externalIdentifiers": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments-create"
|
|
}
|
|
},
|
|
"actualsSourceSetting": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"protocols": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create"
|
|
}
|
|
},
|
|
"externalEnrollments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalEnrollmentTimeSeries-create"
|
|
}
|
|
},
|
|
"labelGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LabelGroups-create"
|
|
}
|
|
},
|
|
"kitTypeTrees": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreeElement-create"
|
|
}
|
|
},
|
|
"demand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings": {
|
|
"title": "Study Actuals Source Settings",
|
|
"type": "object",
|
|
"properties": {
|
|
"CTSMProtocolID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"IRTIdentifier": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true,
|
|
"default": ""
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyActualsSourceSettings-create": {
|
|
"title": "Study Actuals Source Settings (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"CTSMProtocolID": {
|
|
"type": "string",
|
|
"maxLength": 30
|
|
},
|
|
"IRTIdentifier": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true,
|
|
"default": ""
|
|
}
|
|
},
|
|
"required": [
|
|
"CTSMProtocolID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands": {
|
|
"title": "Study Demands",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyDemandID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true,
|
|
"default": "SD-1"
|
|
},
|
|
"processedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"processedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"pushStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"documentStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"demands": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands"
|
|
}
|
|
},
|
|
"demands@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demandSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups"
|
|
}
|
|
},
|
|
"demandSiteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demandBuckets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets"
|
|
}
|
|
},
|
|
"demandBuckets@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"demandsPresentation": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation"
|
|
}
|
|
},
|
|
"demandsPresentation@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDemands-create": {
|
|
"title": "Study Demands (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyDemandID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true,
|
|
"default": "SD-1"
|
|
},
|
|
"processedOn": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true
|
|
},
|
|
"processedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "{i18n>UserID.Description}"
|
|
},
|
|
"pushStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"documentStatus": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"demands": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemands-create"
|
|
}
|
|
},
|
|
"demandSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudySiteGroups-create"
|
|
}
|
|
},
|
|
"demandBuckets": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandBuckets-create"
|
|
}
|
|
},
|
|
"demandsPresentation": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeanStudyDemandsPresentation-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments": {
|
|
"title": "Study Dispensation Treatment Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentDispensationEvent": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentDispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments-create": {
|
|
"title": "Study Dispensation Treatment Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentDispensationEvent": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentDispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatment": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves": {
|
|
"title": "Study Enrollment Curves",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioSiteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupSiteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"enrollmentCurveID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studyDescription": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"scenarioBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"scenarioDescription": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"scenarioStatusDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"scenarioStatusCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"siteGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyEnrollmentCurves-create": {
|
|
"title": "Study Enrollment Curves (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"studyID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"randomizationGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"scenarioSiteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroupSiteGroupID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"enrollmentCurveID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"studyDescription": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"scenarioBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"scenarioDescription": {
|
|
"type": "string",
|
|
"maxLength": 150,
|
|
"nullable": true
|
|
},
|
|
"scenarioStatusDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"scenarioStatusCode": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 1
|
|
},
|
|
"siteGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"siteGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"randomizationGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupBusinessKey": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"studyID",
|
|
"scenarioID",
|
|
"randomizationGroupID",
|
|
"treatmentGroupID",
|
|
"scenarioSiteGroupID",
|
|
"treatmentGroupSiteGroupID",
|
|
"enrollmentCurveID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments": {
|
|
"title": "Study External Identifier Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"externalIdentifier": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"externalIdentifier_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyExternalIdentifierAssignments-create": {
|
|
"title": "Study External Identifier Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"value": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"externalIdentifier": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.ExternalIdentifiers-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"externalIdentifier_ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials": {
|
|
"title": "Study Materials",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 1000,
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyMaterials-create": {
|
|
"title": "Study Materials (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 1000,
|
|
"nullable": true
|
|
},
|
|
"material": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.MaterialsView-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"material_ID": {
|
|
"type": "string",
|
|
"maxLength": 40,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases": {
|
|
"title": "Study Phases",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases-create": {
|
|
"title": "Study Phases (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts": {
|
|
"title": "Study Phases texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyPhases_texts-create": {
|
|
"title": "Study Phases texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols": {
|
|
"title": "Study Protocols",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyProtocols-create": {
|
|
"title": "Study Protocols (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"protocolID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 100,
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses": {
|
|
"title": "Study Regulatory Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses-create": {
|
|
"title": "Study Regulatory Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts": {
|
|
"title": "Study Regulatory Statuses texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyRegulatoryStatuses_texts-create": {
|
|
"title": "Study Regulatory Statuses texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 4
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand": {
|
|
"title": "Study Scenario Additional Demand",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"totalKits": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"demandDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 2000,
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand-create": {
|
|
"title": "Study Scenario Additional Demand (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"totalKits": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"demandDate": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"comment": {
|
|
"type": "string",
|
|
"maxLength": 2000,
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups": {
|
|
"title": "Study Scenario Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"actualEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"activatedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteSeeding": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings"
|
|
}
|
|
},
|
|
"scenarioSiteSeeding@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"scenarioAdditionalDemand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand"
|
|
}
|
|
},
|
|
"scenarioAdditionalDemand@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create": {
|
|
"title": "Study Scenario Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"plannedEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"activatedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.SiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"studySiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteSeeding": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings-create"
|
|
}
|
|
},
|
|
"scenarioAdditionalDemand": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioAdditionalDemand-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings": {
|
|
"title": "Study Scenario Site Seedings",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"seedingGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"suppliedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitsPerSite": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"FSFVOffset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteSeedings-create": {
|
|
"title": "Study Scenario Site Seedings (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"seedingGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"suppliedSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitsPerSite": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"FSFVOffset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"kitType_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitType": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypes-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus": {
|
|
"title": "Study Scenario Status",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus-create": {
|
|
"title": "Study Scenario Status (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts": {
|
|
"title": "Study Scenario Status texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioStatus_texts-create": {
|
|
"title": "Study Scenario Status texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14
|
|
},
|
|
"code": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"default": 1
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"locale",
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses": {
|
|
"title": "Study Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"smEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Study is editable."
|
|
},
|
|
"dfEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Demand forecast is editable."
|
|
},
|
|
"kitIDGenerateEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Medication list can be generated."
|
|
},
|
|
"pushSupplyPlanningEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"IRTImportEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"distributionEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"protocalIdEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Protocol ID is editable."
|
|
},
|
|
"deletionEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"studyCompleted": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses-create": {
|
|
"title": "Study Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"smEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Study is editable."
|
|
},
|
|
"dfEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Demand forecast is editable."
|
|
},
|
|
"kitIDGenerateEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"pushSupplyPlanningEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"IRTImportEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"distributionEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"protocalIdEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false,
|
|
"description": "Protocol ID is editable."
|
|
},
|
|
"deletionEnable": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"studyCompleted": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"code"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts": {
|
|
"title": "Study Statuses texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses_texts-create": {
|
|
"title": "Study Statuses texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments": {
|
|
"title": "Study Timeline Kit Type Assignments",
|
|
"type": "object",
|
|
"properties": {
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitTypeAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments-create": {
|
|
"title": "Study Timeline Kit Type Assignments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitTypeAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"kitType_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"quantity": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"validFrom": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"validTo": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"kitTypeID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID",
|
|
"kitTypeAssignment_ID",
|
|
"kitType_ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods": {
|
|
"title": "Study Timeline Periods",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"durationInDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"startDay": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"colorCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"overage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"dropout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"treatmentDispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"switchFromRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"switchToRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"treatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments"
|
|
}
|
|
},
|
|
"treatments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods-create": {
|
|
"title": "Study Timeline Periods (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"durationInDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"startDay": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"colorCode": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"overage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"dropout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"treatmentDispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"switchFromRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"switchToRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"treatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules": {
|
|
"title": "Study Timeline Schedules",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"TSID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"TGID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"TGID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"TGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"RGID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"RGID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"RGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"subtitle": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"rgPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"tgPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isSync": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetUnit": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"rgFSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"tgFSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"SpecificTreatmentSchedules_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"SpecificDeSyncTGs_TGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"periods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods"
|
|
}
|
|
},
|
|
"periods@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineSchedules-create": {
|
|
"title": "Study Timeline Schedules (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"TSID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"TGID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"TGID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"TGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"RGID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"RGID_INT": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"RGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"subtitle": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"rgPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"tgPosition": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"isSync": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetUnit": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"rgFSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"tgFSFV": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"SpecificTreatmentSchedules_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"SpecificDeSyncTGs_TGUUID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"periods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelinePeriods-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments": {
|
|
"title": "Study Timeline Treatments",
|
|
"type": "object",
|
|
"properties": {
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"period_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"treatment_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"kitTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments"
|
|
}
|
|
},
|
|
"kitTypes@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineTreatments-create": {
|
|
"title": "Study Timeline Treatments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"period_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"treatment_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"kitTypes": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTimelineKitTypeAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"dispensationEvent_ID",
|
|
"treatment_ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses": {
|
|
"title": "Study Transition Statuses",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"transitionStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"transitionStatus_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"transition": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"transition_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses-create": {
|
|
"title": "Study Transition Statuses (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"transitionStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"transitionStatus_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"transition": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"transition_ID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions": {
|
|
"title": "Study Transitions",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"startStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"startStatus_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"toStatus": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses"
|
|
}
|
|
},
|
|
"toStatus@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitions-create": {
|
|
"title": "Study Transitions (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 10
|
|
},
|
|
"startStatus": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyStatuses-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"startStatus_code": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"toStatus": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTransitionStatuses-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents": {
|
|
"title": "Study Treatment Dispensation Events",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"dispensationEventID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments"
|
|
}
|
|
},
|
|
"treatmentAssignments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents-create": {
|
|
"title": "Study Treatment Dispensation Events (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"dispensationEventID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyDispensationTreatmentAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups": {
|
|
"title": "Study Treatment Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyTreatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"offset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetUnit": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"ratioPercent": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"ratioAbsolute": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups"
|
|
}
|
|
},
|
|
"treatmentGroupSiteGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"treatmentPeriods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
},
|
|
"treatmentPeriods@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create": {
|
|
"title": "Study Treatment Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"studyTreatmentGroupID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"offset": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"offsetUnit": {
|
|
"type": "string",
|
|
"maxLength": 1,
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"default": 0
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"ratioPercent": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"ratioAbsolute": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroupSiteGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups-create"
|
|
}
|
|
},
|
|
"treatmentPeriods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods": {
|
|
"title": "Study Treatment Periods",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"durationInDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 1
|
|
},
|
|
"startDay": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"colorCode": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"overage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.01,
|
|
"maximum": 999.99,
|
|
"minimum": -999.99,
|
|
"nullable": true
|
|
},
|
|
"dropout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.01,
|
|
"maximum": 999.99,
|
|
"minimum": -999.99,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"dispensationEvents": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents"
|
|
}
|
|
},
|
|
"dispensationEvents@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"switchFrom": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
},
|
|
"switchFrom@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"switchTo": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
},
|
|
"switchTo@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create": {
|
|
"title": "Study Treatment Periods (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"durationInDays": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"position": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 1
|
|
},
|
|
"startDay": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": true
|
|
},
|
|
"colorCode": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"overage": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.01,
|
|
"maximum": 999.99,
|
|
"minimum": -999.99,
|
|
"nullable": true
|
|
},
|
|
"dropout": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"multipleOf": 0.01,
|
|
"maximum": 999.99,
|
|
"minimum": -999.99,
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"dispensationEvents": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentDispensationEvents-create"
|
|
}
|
|
},
|
|
"switchFrom": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches-create"
|
|
}
|
|
},
|
|
"switchTo": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs": {
|
|
"title": "Study Treatment Schedule DeSyncTGs",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs-create": {
|
|
"title": "Study Treatment Schedule De Sync T Gs (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments": {
|
|
"title": "Study Treatment Schedule Treatments",
|
|
"type": "object",
|
|
"properties": {
|
|
"schdule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod_description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"dispensationEventID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"dispensationEvent_description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"treatment_description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments-create": {
|
|
"title": "Study Treatment Schedule Treatments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"schdule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriodID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriod_description": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"isDispensationPeriod": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"dispensationEvent_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"dispensationEventID": {
|
|
"type": "string",
|
|
"maxLength": 30,
|
|
"nullable": true
|
|
},
|
|
"dispensationEvent_description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"treatmentAssignment_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"treatment_description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"schdule_ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules": {
|
|
"title": "Study Treatment Schedules",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
},
|
|
"treatmentPeriods@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"desynchronizedTreatmentGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs"
|
|
}
|
|
},
|
|
"desynchronizedTreatmentGroups@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"assignedTreatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments"
|
|
}
|
|
},
|
|
"assignedTreatments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"switches": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches"
|
|
}
|
|
},
|
|
"switches@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules-create": {
|
|
"title": "Study Treatment Schedules (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"isLastPeriodRepeatEnabled": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"weeksPriorToLastPeriodForRepeat": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.RandomizationGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"randomizationGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentPeriods": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
},
|
|
"desynchronizedTreatmentGroups": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleDeSyncTGs-create"
|
|
}
|
|
},
|
|
"assignedTreatments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentScheduleTreatments-create"
|
|
}
|
|
},
|
|
"switches": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches": {
|
|
"title": "Study Treatment Switches",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"switchID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"switchRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"fromPeriod_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"toPeriod_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"fromTreatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"fromTreatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"toTreatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"toTreatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"fromPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"fromPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"toPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"toPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSwitches-create": {
|
|
"title": "Study Treatment Switches (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"switchID": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"switchRate": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"fromPeriod_BK": {
|
|
"type": "string",
|
|
"nullable": true
|
|
},
|
|
"toPeriod_BK": {
|
|
"type": "string",
|
|
"nullable": true,
|
|
"description": "Business key."
|
|
},
|
|
"treatmentSchedule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentSchedules-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentSchedule_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"fromTreatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"fromTreatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"toTreatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"toTreatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"fromPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"fromPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"toPeriod": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentPeriods-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"toPeriod_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments": {
|
|
"title": "Study Treatments",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments"
|
|
}
|
|
},
|
|
"kitTypeAssignments@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatments-create": {
|
|
"title": "Study Treatments (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"treatmentID": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"scenario": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Scenarios-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenario_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"study": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.Studies-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"study_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"kitTypeAssignments": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.KitTypeTreatmentAssignments-create"
|
|
}
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes": {
|
|
"title": "Study Types",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes-create": {
|
|
"title": "Study Types (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts": {
|
|
"title": "Study Types texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTypes_texts-create": {
|
|
"title": "Study Types texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"description": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas": {
|
|
"title": "Therapeutic Areas",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"therapeuticAreaDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
},
|
|
"texts@odata.count": {
|
|
"$ref": "#/components/schemas/count"
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas-create": {
|
|
"title": "Therapeutic Areas (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"sort_num": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5
|
|
},
|
|
"therapeuticAreaDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
},
|
|
"isObsolete": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"texts": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts-create"
|
|
}
|
|
},
|
|
"localized": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts": {
|
|
"title": "Therapeutic Areas texts",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"therapeuticAreaDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TherapeuticAreas_texts-create": {
|
|
"title": "Therapeutic Areas texts (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID_texts": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"locale": {
|
|
"type": "string",
|
|
"maxLength": 14,
|
|
"nullable": true
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"maxLength": 5,
|
|
"nullable": true
|
|
},
|
|
"therapeuticAreaDescription": {
|
|
"type": "string",
|
|
"maxLength": 60,
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID_texts"
|
|
]
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups": {
|
|
"title": "Treatment Group Site Groups",
|
|
"type": "object",
|
|
"properties": {
|
|
"createdAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the record creation in the Clinical Supply Managemet environment."
|
|
},
|
|
"createdBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who created the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedAt": {
|
|
"type": "string",
|
|
"format": "date-time",
|
|
"example": "2017-04-13T15:51:04.0000000Z",
|
|
"nullable": true,
|
|
"description": "The timestamp of the last record change in the Clinical Supply Managemet environment."
|
|
},
|
|
"modifiedBy": {
|
|
"type": "string",
|
|
"maxLength": 255,
|
|
"nullable": true,
|
|
"description": "The user who last changed the record in the Clinical Supply Managemet environment."
|
|
},
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"actualEnrollment": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollmentManualDF": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
}
|
|
},
|
|
"com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.TreatmentGroupSiteGroups-create": {
|
|
"title": "Treatment Group Site Groups (for create)",
|
|
"type": "object",
|
|
"properties": {
|
|
"ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef"
|
|
},
|
|
"active": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"regulatoryApproval": {
|
|
"type": "boolean",
|
|
"nullable": true
|
|
},
|
|
"firstSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"lastSubjectFirstVisit": {
|
|
"type": "string",
|
|
"format": "date",
|
|
"example": "2017-04-13",
|
|
"nullable": true
|
|
},
|
|
"plannedEnrollment": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"format": "decimal",
|
|
"example": 0,
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"plannedNumberOfSites": {
|
|
"type": "integer",
|
|
"format": "int32",
|
|
"nullable": true,
|
|
"maximum": 2147483647,
|
|
"minimum": 0
|
|
},
|
|
"manualEnrollment": {
|
|
"type": "boolean",
|
|
"nullable": true,
|
|
"default": false
|
|
},
|
|
"siteGroupId": {
|
|
"type": "string",
|
|
"maxLength": 10,
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.EnrollmentCurves-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"enrollmentCurve_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyTreatmentGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"treatmentGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.StudyScenarioSiteGroups-create"
|
|
}
|
|
],
|
|
"nullable": true
|
|
},
|
|
"scenarioSiteGroup_ID": {
|
|
"type": "string",
|
|
"format": "uuid",
|
|
"example": "01234567-89ab-cdef-0123-456789abcdef",
|
|
"nullable": true
|
|
}
|
|
},
|
|
"required": [
|
|
"ID"
|
|
]
|
|
},
|
|
"count": {
|
|
"anyOf": [
|
|
{
|
|
"type": "number"
|
|
},
|
|
{
|
|
"type": "string"
|
|
}
|
|
],
|
|
"description": "The number of entities in the collection. Available when using the [$count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount) query option."
|
|
},
|
|
"error": {
|
|
"type": "object",
|
|
"required": [
|
|
"error"
|
|
],
|
|
"properties": {
|
|
"error": {
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"type": "string"
|
|
},
|
|
"details": {
|
|
"type": "array",
|
|
"items": {
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"code": {
|
|
"type": "string"
|
|
},
|
|
"message": {
|
|
"type": "string"
|
|
},
|
|
"target": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"innererror": {
|
|
"type": "object",
|
|
"description": "The structure of this object is service-specific"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"parameters": {
|
|
"top": {
|
|
"name": "$top",
|
|
"in": "query",
|
|
"description": "Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
},
|
|
"example": 50
|
|
},
|
|
"skip": {
|
|
"name": "$skip",
|
|
"in": "query",
|
|
"description": "Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)",
|
|
"schema": {
|
|
"type": "integer",
|
|
"minimum": 0
|
|
}
|
|
},
|
|
"count": {
|
|
"name": "$count",
|
|
"in": "query",
|
|
"description": "Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)",
|
|
"schema": {
|
|
"type": "boolean"
|
|
}
|
|
},
|
|
"search": {
|
|
"name": "$search",
|
|
"in": "query",
|
|
"description": "Search items by search phrases, see [Searching](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionsearch)",
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
},
|
|
"responses": {
|
|
"401": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "Error",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/error"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} |