POST Requests/GetCompatibleDataMarts
Gets a list of DataMarts that are compatible with the current request's criteria, stratifiers etc.
Request Information
URI Parameters
None.
Body Parameters
MatchingCriteriaDTOName | Description | Type | Additional information |
---|---|---|---|
TermIDs |
Available Terms |
Collection of globally unique identifier |
None. |
ProjectID |
Gets or sets the ID of project |
globally unique identifier |
None. |
Request |
The Request json to use when retrieving datamarts capable of responding. |
string |
None. |
RequestID |
Gets or sets the ID of the Request |
globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "results": [ { "TermIDs": [ "ee702033-01df-4267-8ae9-7ed8c3fdad5e", "d6ddc364-15a6-4069-9020-37968767fc4c" ], "ProjectID": "81bdd30d-55d6-4fef-b43b-c8e030d84479", "Request": "sample string 1", "RequestID": "1539d59a-1915-4671-9061-533943c244db" } ] }
text/javascript
Sample:
{"results":[{"TermIDs":["ee702033-01df-4267-8ae9-7ed8c3fdad5e","d6ddc364-15a6-4069-9020-37968767fc4c"],"ProjectID":"81bdd30d-55d6-4fef-b43b-c8e030d84479","Request":"sample string 1","RequestID":"1539d59a-1915-4671-9061-533943c244db"}]}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
Sample:
<MatchingCriteriaDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO.QueryComposer"> <ProjectID>81bdd30d-55d6-4fef-b43b-c8e030d84479</ProjectID> <Request>sample string 1</Request> <RequestID>1539d59a-1915-4671-9061-533943c244db</RequestID> <TermIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>ee702033-01df-4267-8ae9-7ed8c3fdad5e</d2p1:guid> <d2p1:guid>d6ddc364-15a6-4069-9020-37968767fc4c</d2p1:guid> </TermIDs> </MatchingCriteriaDTO>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Collection of DataMartListDTOName | Description | Type | Additional information |
---|---|---|---|
Name |
DataMart Name |
string |
None. |
Description |
DataMart Description |
string |
None. |
Acronym |
DataMart Acronym |
string |
None. |
StartDate |
The date the DataMart was created on |
date |
None. |
EndDate |
The date the DataMart was ended on |
date |
None. |
OrganizationID |
Identifier of Organization |
globally unique identifier |
None. |
Organization |
Organization |
string |
None. |
ParentOrganziationID |
Gets or set the ID of the Organizations parent organization. |
globally unique identifier |
None. |
ParentOrganization |
Gets or sets the name of the Organizations parent organization. |
string |
None. |
ID | globally unique identifier |
None. |
|
Timestamp | Collection of byte |
None. |
Response Formats
application/json, text/json
Sample:
{ "results": [ { "Name": "sample string 1", "Description": "sample string 2", "Acronym": "sample string 3", "StartDate": "2024-05-15T03:37:57Z", "EndDate": "2024-05-15T03:37:57Z", "OrganizationID": "8aabb4de-334f-47da-891b-f15eca54348b", "Organization": "sample string 4", "ParentOrganziationID": "c77cc579-8e7c-4708-b936-ad1e0475a91b", "ParentOrganization": "sample string 5", "ID": "3984e6ba-480e-45ad-b7f0-0bd96defdb49", "Timestamp": "QEA=" }, { "Name": "sample string 1", "Description": "sample string 2", "Acronym": "sample string 3", "StartDate": "2024-05-15T03:37:57Z", "EndDate": "2024-05-15T03:37:57Z", "OrganizationID": "8aabb4de-334f-47da-891b-f15eca54348b", "Organization": "sample string 4", "ParentOrganziationID": "c77cc579-8e7c-4708-b936-ad1e0475a91b", "ParentOrganization": "sample string 5", "ID": "3984e6ba-480e-45ad-b7f0-0bd96defdb49", "Timestamp": "QEA=" } ] }
text/javascript
Sample:
{"results":[{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-15T03:37:57Z","EndDate":"2024-05-15T03:37:57Z","OrganizationID":"8aabb4de-334f-47da-891b-f15eca54348b","Organization":"sample string 4","ParentOrganziationID":"c77cc579-8e7c-4708-b936-ad1e0475a91b","ParentOrganization":"sample string 5","ID":"3984e6ba-480e-45ad-b7f0-0bd96defdb49","Timestamp":"QEA="},{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-15T03:37:57Z","EndDate":"2024-05-15T03:37:57Z","OrganizationID":"8aabb4de-334f-47da-891b-f15eca54348b","Organization":"sample string 4","ParentOrganziationID":"c77cc579-8e7c-4708-b936-ad1e0475a91b","ParentOrganization":"sample string 5","ID":"3984e6ba-480e-45ad-b7f0-0bd96defdb49","Timestamp":"QEA="}]}
application/bson
Sample:
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
Sample:
<ArrayOfDataMartListDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO"> <DataMartListDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">3984e6ba-480e-45ad-b7f0-0bd96defdb49</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Acronym>sample string 3</Acronym> <Description>sample string 2</Description> <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T07:37:57.1044951Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </EndDate> <Name>sample string 1</Name> <Organization>sample string 4</Organization> <OrganizationID>8aabb4de-334f-47da-891b-f15eca54348b</OrganizationID> <ParentOrganization>sample string 5</ParentOrganization> <ParentOrganziationID>c77cc579-8e7c-4708-b936-ad1e0475a91b</ParentOrganziationID> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T07:37:57.1044951Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </StartDate> </DataMartListDTO> <DataMartListDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">3984e6ba-480e-45ad-b7f0-0bd96defdb49</ID> <Timestamp xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">QEA=</Timestamp> <Acronym>sample string 3</Acronym> <Description>sample string 2</Description> <EndDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T07:37:57.1044951Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </EndDate> <Name>sample string 1</Name> <Organization>sample string 4</Organization> <OrganizationID>8aabb4de-334f-47da-891b-f15eca54348b</OrganizationID> <ParentOrganization>sample string 5</ParentOrganization> <ParentOrganziationID>c77cc579-8e7c-4708-b936-ad1e0475a91b</ParentOrganziationID> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-15T07:37:57.1044951Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </StartDate> </DataMartListDTO> </ArrayOfDataMartListDTO>