POST Requests/GetDataMartsForInstalledModels
Gets a list of DataMarts that are compatible, i.e. the Terms specified are supported, with the installed models on the DataMarts with the option to limit by ProjectID. Important: This function should not be used for QueryComposer request since they should not use the Installed Models. Also, the Request member of the MatchingCriteria does not affect the results.
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
{ "results": [ { "TermIDs": [ "53ce7f0b-cd0a-4552-ab44-6e7bfaba1a2e", "f87db250-7594-4008-a7f8-cfe2b367c9a3" ], "ProjectID": "566cd512-b636-40b3-a28f-d946f97896d3", "Request": "sample string 1", "RequestID": "7e6b6bc8-8b9e-47bf-b0c9-e02a1ba059fd" } ] }
text/javascript
{"results":[{"TermIDs":["53ce7f0b-cd0a-4552-ab44-6e7bfaba1a2e","f87db250-7594-4008-a7f8-cfe2b367c9a3"],"ProjectID":"566cd512-b636-40b3-a28f-d946f97896d3","Request":"sample string 1","RequestID":"7e6b6bc8-8b9e-47bf-b0c9-e02a1ba059fd"}]}
application/bson
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
<MatchingCriteriaDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Lpp.Dns.DTO.QueryComposer"> <ProjectID>566cd512-b636-40b3-a28f-d946f97896d3</ProjectID> <Request>sample string 1</Request> <RequestID>7e6b6bc8-8b9e-47bf-b0c9-e02a1ba059fd</RequestID> <TermIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>53ce7f0b-cd0a-4552-ab44-6e7bfaba1a2e</d2p1:guid> <d2p1:guid>f87db250-7594-4008-a7f8-cfe2b367c9a3</d2p1:guid> </TermIDs> </MatchingCriteriaDTO>
application/x-www-form-urlencoded
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
{ "results": [ { "Name": "sample string 1", "Description": "sample string 2", "Acronym": "sample string 3", "StartDate": "2024-05-14T02:25:43Z", "EndDate": "2024-05-14T02:25:43Z", "OrganizationID": "4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d", "Organization": "sample string 4", "ParentOrganziationID": "6028cec6-a08a-4157-b5a9-19227404fe6d", "ParentOrganization": "sample string 5", "ID": "249caa5a-0487-4e1e-bb72-91c5271256ec", "Timestamp": "QEA=" }, { "Name": "sample string 1", "Description": "sample string 2", "Acronym": "sample string 3", "StartDate": "2024-05-14T02:25:43Z", "EndDate": "2024-05-14T02:25:43Z", "OrganizationID": "4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d", "Organization": "sample string 4", "ParentOrganziationID": "6028cec6-a08a-4157-b5a9-19227404fe6d", "ParentOrganization": "sample string 5", "ID": "249caa5a-0487-4e1e-bb72-91c5271256ec", "Timestamp": "QEA=" } ] }
text/javascript
{"results":[{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-14T02:25:43Z","EndDate":"2024-05-14T02:25:43Z","OrganizationID":"4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d","Organization":"sample string 4","ParentOrganziationID":"6028cec6-a08a-4157-b5a9-19227404fe6d","ParentOrganization":"sample string 5","ID":"249caa5a-0487-4e1e-bb72-91c5271256ec","Timestamp":"QEA="},{"Name":"sample string 1","Description":"sample string 2","Acronym":"sample string 3","StartDate":"2024-05-14T02:25:43Z","EndDate":"2024-05-14T02:25:43Z","OrganizationID":"4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d","Organization":"sample string 4","ParentOrganziationID":"6028cec6-a08a-4157-b5a9-19227404fe6d","ParentOrganization":"sample string 5","ID":"249caa5a-0487-4e1e-bb72-91c5271256ec","Timestamp":"QEA="}]}
application/bson
Binary JSON content. See http://bsonspec.org for details.
application/xml, text/xml
<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">249caa5a-0487-4e1e-bb72-91c5271256ec</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-14T06:25:43.078082Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </EndDate> <Name>sample string 1</Name> <Organization>sample string 4</Organization> <OrganizationID>4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d</OrganizationID> <ParentOrganization>sample string 5</ParentOrganization> <ParentOrganziationID>6028cec6-a08a-4157-b5a9-19227404fe6d</ParentOrganziationID> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T06:25:43.078082Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </StartDate> </DataMartListDTO> <DataMartListDTO> <ID xmlns="http://schemas.datacontract.org/2004/07/Lpp.Objects">249caa5a-0487-4e1e-bb72-91c5271256ec</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-14T06:25:43.078082Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </EndDate> <Name>sample string 1</Name> <Organization>sample string 4</Organization> <OrganizationID>4f4d9c73-9ebc-4f71-84ab-ad95a01edd3d</OrganizationID> <ParentOrganization>sample string 5</ParentOrganization> <ParentOrganziationID>6028cec6-a08a-4157-b5a9-19227404fe6d</ParentOrganziationID> <StartDate xmlns:d3p1="http://schemas.datacontract.org/2004/07/System"> <d3p1:DateTime>2024-05-14T06:25:43.078082Z</d3p1:DateTime> <d3p1:OffsetMinutes>-240</d3p1:OffsetMinutes> </StartDate> </DataMartListDTO> </ArrayOfDataMartListDTO>