Retrieve a list of lead molecules.
GET {{baseUrl}}/LeadMolecules?$top=<integer>&$skip=<integer>&$search=<string>&$filter=<string>&$count=<boolean>&$orderby=createdBy,externalID desc&$select=isObsolete,modifiedAt&$expand=texts,localized
Response Type:
Title: Lead Molecules
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - createdAt | No | string | No | - | The timestamp of the record creation in the Clinical Supply Managemet environment. |
| - createdBy | No | string | No | - | The user who created the record in the Clinical Supply Managemet environment. |
| - modifiedAt | No | string | No | - | The timestamp of the last record change in the Clinical Supply Managemet environment. |
| - modifiedBy | No | string | No | - | The user who last changed the record in the Clinical Supply Managemet environment. |
| - sort_num | No | integer | No | - | - |
| - ID | No | string | No | - | - |
| - description | No | string | No | - | - |
| - isObsolete | No | boolean | No | - | - |
| - externalID | No | string | No | - | - |
| - sourceSystem | No | string | No | - | - |
| - texts | No | array | No | - | - |
| - texts@odata.count | No | object | No | In #/components/schemas/count | The number of entities in the collection. Available when using the $count query option. |
| - localized | No | object | No | Same as Lead Molecules texts | - |
Property Lead Molecules > createdAt
| |
|---|
| Type | string |
| Required | No |
| Format | date-time |
Description: The timestamp of the record creation in the Clinical Supply Managemet environment.
Property Lead Molecules > createdBy
Description: The user who created the record in the Clinical Supply Managemet environment.
| Restrictions | |
|---|
| Max length | 255 |
Property Lead Molecules > modifiedAt
| |
|---|
| Type | string |
| Required | No |
| Format | date-time |
Description: The timestamp of the last record change in the Clinical Supply Managemet environment.
Property Lead Molecules > modifiedBy
Description: The user who last changed the record in the Clinical Supply Managemet environment.
| Restrictions | |
|---|
| Max length | 255 |
Property Lead Molecules > sort_num
| |
|---|
| Type | integer |
| Required | No |
| Format | int32 |
Property Lead Molecules > ID
Property Lead Molecules > description
Property Lead Molecules > isObsolete
| |
|---|
| Type | boolean |
| Required | No |
| Default | false |
Property Lead Molecules > externalID
Property Lead Molecules > sourceSystem
Property Lead Molecules > texts
| Array restrictions |
|---|
| Min items | N/A |
| Max items | N/A |
| Items unicity | False |
| Additional items | False |
| Tuple validation | See below |
Lead Molecules > texts > com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts
| |
|---|
| Type | object |
| Required | No |
| Additional properties | [Any type: allowed] |
| Defined in | #/components/schemas/com.sap.ctsm.backend.core.api.study.v1.StudyAPIv1.LeadMolecules_texts |
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|
| - ID_texts | No | string | No | - | - |
| - locale | No | string | No | - | - |
| - ID | No | string | No | - | - |
| - description | No | string | No | - | - |
Property Lead Molecules > texts > Lead Molecules texts > ID_texts
| |
|---|
| Type | string |
| Required | No |
| Format | uuid |
Property Lead Molecules > texts > Lead Molecules texts > locale
Property Lead Molecules > texts > Lead Molecules texts > ID
Property Lead Molecules > texts > Lead Molecules texts > description
Property Lead Molecules > texts@odata.count
| |
|---|
| Type | combining |
| Required | No |
| Additional properties | [Any type: allowed] |
| Defined in | #/components/schemas/count |
Description: The number of entities in the collection. Available when using the $count query option.
Property Lead Molecules > texts@odata.count > anyOf > item 0
Property Lead Molecules > texts@odata.count > anyOf > item 1
Property Lead Molecules > localized
Generated using json-schema-for-humans on 2024-02-27 at 13:33:37 +0100
Request Params
| Key | Datatype | Required | Description |
|---|
$top | string | | Show only the first n items, see Paging - Top |
$skip | string | | Skip the first n items, see Paging - Skip |
$search | string | | Search items by search phrases, see Searching |
$filter | string | | Filter items by property values, see Filtering |
$count | string | | Include count of items, see Count |
$orderby | string | | Order items by property values, see Sorting |
$select | string | | Select properties to be returned, see Select |
$expand | string | | Expand related entities, see Expand |
| Key | Datatype | Required | Description |
|---|
Accept | string | | |
RESPONSES
status: OK
{"info":"To visualize API response schema, click on Visualization tab","@odata.count":"2","value":[{"createdAt":"2024-2-14","createdBy":"jonico","modifiedAt":"0:00","modifiedBy":"lillisebe","sort_num":"1","ID":"1","description":"Postmanium","isObsolete":false,"externalID":"42","sourceSystem":"SAP","texts":[{"ID_texts":"1234","locale":"de","ID":"1","description":"Postmannium"},{"ID_texts":"4321","locale":"fr","ID":"2","description":"Le Postmanium"}],"texts@odata.count":"\u003cnumber\u003e","localized":{"ID_texts":"\u003cuuid\u003e","locale":"\u003cstring\u003e","ID":"\u003cstring\u003e","description":"\u003cstring\u003e"}},{"createdAt":"\u003cdateTime\u003e","createdBy":"\u003cstring\u003e","modifiedAt":"\u003cdateTime\u003e","modifiedBy":"\u003cstring\u003e","sort_num":"\u003cinteger\u003e","ID":"\u003cstring\u003e","description":"\u003cstring\u003e","isObsolete":false,"externalID":"\u003cstring\u003e","sourceSystem":"\u003cstring\u003e","texts":[{"ID_texts":"\u003cuuid\u003e","locale":"\u003cstring\u003e","ID":"\u003cstring\u003e","description":"\u003cstring\u003e"},{"ID_texts":"\u003cuuid\u003e","locale":"\u003cstring\u003e","ID":"\u003cstring\u003e","description":"\u003cstring\u003e"}],"texts@odata.count":"\u003cnumber\u003e","localized":{"ID_texts":"\u003cuuid\u003e","locale":"\u003cstring\u003e","ID":"\u003cstring\u003e","description":"\u003cstring\u003e"}}]}