REST API - findResources - by name

The table summarizes the REST API - findResources.

Request

Format
GET <baseurl>/orgresource/find
Query parameters
  • name=List<String>: The collection of names to search for. Can be obtained using listCandidateResources .
  • current=boolean (optional, default = false): Indicates whether only resources currently active (according to any date range applied) are to be included (true). If false, any date ranges applied to the resource are ignored.

Response

JSON Returns a JSON representation of the content of the findResourcesResponse element.
XML Returns the content of the findResourcesResponse element (from the OrgResourceService schema).

Example

Request
GET <baseurl>/orgresource/find?name=Clint%20Hill&name=John%20Eustace&current=true
Response
{
  "xml-fragment": {
    "-model-version": "3",
    "resource": [
      {
        "-guid": "475EF08A-0C50-40AD-AA88-106E1419BEA2",
        "-name": "Clint Hill",
        "-label": "Clint Hill"
      },
      {
        "-guid": "843D2F63-69C4-4BC4-8547-55C4B127CF79",
        "-name": "John Eustace",
        "-label": "John Eustace"
      }
    ]
  }
}