Resource: Assigned To Search ( /api/assignedtosearch )

Allows the searching of applicable assigned to values by partial name (including groups, users and special values such as 'Me').

Root Relation: AssignedToSearch

This resource supports the following methods: GET, POST

Methods

GET

Searches for users, groups and special users e.g. currently logged in user (self) by partial name match

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the query request was satisfied.

Example - Search using query

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

Request Headers

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

Request Parameters

KeyValueDescription
queryMThe partial values query

Response Headers

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

Response Body

{
  "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

POST

Searches for users, groups and special users e.g. currently logged in user (self) by partial name match (using POST to allow large existing value queries)

Status Codes

These are the expected status codes returned by the service. In addition, some other status codes may be returned if either an internal error occurs or there is an authentication issue (such as an expired OAuth token).

StatusDescription
200 - OKReturned if the query request was satisfied.

Example - Search using query

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

Request Headers

KeyValueDescription
Content-Typeapplication/x-www-form-urlencoded

Request Parameters

KeyValueDescription
queryMThe partial values query

Response Headers

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

Response Body

{
  "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

  • No labels