GET api/Get_Use_Cases_List

Get list of available use cases

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Get_Use_Cases_List_Response

Name	Type	Additional information
Request_Type	string	None.
Request_Parameters	Object	None.
Data	Get_Use_Cases_List_Response_Record	None.
Response_Tail	Response_Tail_Record	None.

Response Formats

application/json, text/json

Sample:

{
  "Request_Type": "sample string 1",
  "Request_Parameters": {},
  "Data": {
    "Use_Cases_List": [
      {
        "ID": 1,
        "Use_Case": "sample string 2",
        "Use_Case_Description": "sample string 3"
      },
      {
        "ID": 1,
        "Use_Case": "sample string 2",
        "Use_Case_Description": "sample string 3"
      }
    ]
  },
  "Response_Tail": {
    "Time_Stamp": "sample string 1",
    "Status": "sample string 2",
    "Build_Number": "sample string 3",
    "Execution_Time_In_Milliseconds": 4,
    "Errors_List": [
      {
        "Error_Time": "2026-06-27T18:22:57.6439371+00:00",
        "Error_Text": "sample string 2",
        "Error_Type": 0
      },
      {
        "Error_Time": "2026-06-27T18:22:57.6439371+00:00",
        "Error_Text": "sample string 2",
        "Error_Type": 0
      }
    ]
  }
}

application/xml, text/xml

Sample:

<Get_Use_Cases_List_Response xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Cognitive_Layer_API">
  <Data>
    <Use_Cases_List>
      <Get_Use_Cases_List_Element_Record>
        <ID>1</ID>
        <Use_Case>sample string 2</Use_Case>
        <Use_Case_Description>sample string 3</Use_Case_Description>
      </Get_Use_Cases_List_Element_Record>
      <Get_Use_Cases_List_Element_Record>
        <ID>1</ID>
        <Use_Case>sample string 2</Use_Case>
        <Use_Case_Description>sample string 3</Use_Case_Description>
      </Get_Use_Cases_List_Element_Record>
    </Use_Cases_List>
  </Data>
  <Request_Parameters />
  <Request_Type>sample string 1</Request_Type>
  <Response_Tail>
    <Build_Number>sample string 3</Build_Number>
    <Errors_List xmlns:d3p1="http://schemas.datacontract.org/2004/07/IA_Tools">
      <d3p1:IA_Error_Item>
        <d3p1:Error_Text>sample string 2</d3p1:Error_Text>
        <d3p1:Error_Time>2026-06-27T18:22:57.6439371+00:00</d3p1:Error_Time>
        <d3p1:Error_Type>Message</d3p1:Error_Type>
      </d3p1:IA_Error_Item>
      <d3p1:IA_Error_Item>
        <d3p1:Error_Text>sample string 2</d3p1:Error_Text>
        <d3p1:Error_Time>2026-06-27T18:22:57.6439371+00:00</d3p1:Error_Time>
        <d3p1:Error_Type>Message</d3p1:Error_Type>
      </d3p1:IA_Error_Item>
    </Errors_List>
    <Execution_Time_In_Milliseconds>4</Execution_Time_In_Milliseconds>
    <Status>sample string 2</Status>
    <Time_Stamp>sample string 1</Time_Stamp>
  </Response_Tail>
</Get_Use_Cases_List_Response>