Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Example - Search using query

Search for all 'Assigned To' values starting with the letter M

Request Headers

KeyValueDescription
AcceptContent-Typeapplication/json; charset=utf-8

Request Parameters

KeyValueDescription
queryMThe partial values query

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Skip": 0,
  "Top": 3,
  "Total": 25,
  "Items": [
    {
      "Id": "357ec7c6-f1e1-4b4b-b248-c7346774d466",
      "Type": "Group",
      "Name": "Managers",
      "GlobalId": "Group:357ec7c6-f1e1-4b4b-b248-c7346774d466",
      "CssClass": "assigned-to-group"
    },
    {
      "Type": "Self",
      "Name": "Me",
      "GlobalId": "Self",
      "CssClass": "assigned-to-self"
    },
    {
      "Id": "e68c26d3-888f-4fa5-96e3-88c5d6368fb9",
      "Type": "User",
      "Name": "Michael Mango",
      "GlobalId": "User:e68c26d3-888f-4fa5-96e3-88c5d6368fb9",
      "CssClass": "assigned-to-user"
    }
  ],
  "Self": "http://localhost/api/api/assignedtosearch?query=M",
  "Links": [
    {
      "Href": "http://localhost/api/api/assignedtosearch?query=M&$skip=3&$top=3",
      "Rel": "next"
    },
    {
      "Href": "http://localhost/api/api/assignedtosearch?query=M&$skip=22&$top=3",
      "Rel": "last"
    }
  ]
}

Status Code

200 - OK

...

Example - Search using query

Search for all 'Assigned To' values starting with the letter M

Request Headers

KeyValueDescription
AcceptContent-Typeapplication/jsonx-www-form-urlencoded

Request Parameters

KeyValueDescription
queryMThe partial values query

Response Headers

KeyValueDescription
Content-Typeapplication/json; charset=utf-8

Response Body

Code Block
languagenone
{
  "Skip": 0,
  "Top": 3,
  "Total": 25,
  "Items": [
    {
      "Id": "357ec7c6-f1e1-4b4b-b248-c7346774d466",
      "Type": "Group",
      "Name": "Managers",
      "GlobalId": "Group:357ec7c6-f1e1-4b4b-b248-c7346774d466",
      "CssClass": "assigned-to-group"
    },
    {
      "Type": "Self",
      "Name": "Me",
      "GlobalId": "Self",
      "CssClass": "assigned-to-self"
    },
    {
      "Id": "e68c26d3-888f-4fa5-96e3-88c5d6368fb9",
      "Type": "User",
      "Name": "Michael Mango",
      "GlobalId": "User:e68c26d3-888f-4fa5-96e3-88c5d6368fb9",
      "CssClass": "assigned-to-user"
    }
  ],
  "Self": "http://localhost/api/api/assignedtosearch",
  "Links": [
    {
      "Href": "http://localhost/api/api/assignedtosearch?$skip=3&$top=3",
      "Rel": "next"
    },
    {
      "Href": "http://localhost/api/api/assignedtosearch?$skip=22&$top=3",
      "Rel": "last"
    }
  ]
}

Status Code

200 - OK

...