GET Project/{id}/Guide

• 4 minutes to read
 • 4 minutes to read 
GET /api/v1/Project/{id}/Guide

OData list of Guide under a specific ProjectEntity.

Can be sorted and further filtered using OData conventions:

  • Project/1234/Guide?$select=col1,col2,abc/col3
  • Project/1234/Guide?$filter=col1 eq 'foo' and startswith(col2, 'baz')
  • Project/1234/Guide?$orderby=abc/col3,col1
  • Project/1234/Guide?$top=1000
  • Project/1234/Guide?$mode=full

OData returns XML or JSON carriers depending on the HTTP Accept header.

Calls the Archive service using the "ProjectGuide" archive provider.

Filter Operators:

ints: eq =, ne, le, lt, gt, ge, set, equals, greater, less, unequals, between

strings: contains, is, notBegins, notContains, isNot

associate: associateIsOneOf, associateIsNotOneOf,

list ids: oneOf, NotOneOf,

dates: before, date, after, dateBetween, beforeToday

Unary ops: currentAssociate, beforeToday, today, afterToday, lastWeek, thisWeek, nextWeek, lastMonth, thisMonth, nextMonth, lastQuarter, thisQuarter, nextQuarter, thisHalf, thisYear

Funcs: substringof(a,b), startswith(a,b), endswith(a,b), this(f,period), next(f,n,period), previous(f,n,period), thisAndNext(f,n,period), thisAndPrevious(f,n,period), thisAndPreviousAndNext(f,period)

Path Part Type Description
id int32 The entity id Required

Query String Parameters

Parameter Name Type Description
$select string Comma separated list of column names to return. "nameDepartment,fullname,category". Can also use aggregation functions and modifiers: "Count(category):Footer"
$filter string Expression to restrict the results. e.g.: "name begins 'foo' and category gt 1"
$orderBy string Comma separated list of column names to sort by, with optional direction. "name asc,fullname,category desc"
$entities string Comma separated list of entity names to use. Default = 'appointment,document'
$top int32 Number of rows to return in results
$skip int32 Number of rows from database to skip before returning results
$mode Enum: Slim, Wide, Full FULL (with raw values and hints for each value) or SLIM (just the display values)
$options string Provider specific options. e.g: "GrandTotal=true"
$context string Provider specific context parameter.
$format string Set XML or JSON output format; override the format determined from Accept header.
$jsonSafe bool Make output names into JSON safe property names. Replace all unsafe characters with _ underscore.
$output Enum: Logical, Display Return Logical or Display values in SLIM mode. Logical returns true/false for booleans, Display returns icon hints. Dates are always returned as ISO strings. 
GET /api/v1/Project/{id}/Guide?$select=name,department,category/id
GET /api/v1/Project/{id}/Guide?$filter=name begins 'S'
GET /api/v1/Project/{id}/Guide?$orderBy=name asc
GET /api/v1/Project/{id}/Guide?$entities=provident
GET /api/v1/Project/{id}/Guide?$top=891
GET /api/v1/Project/{id}/Guide?$skip=63
GET /api/v1/Project/{id}/Guide?$mode=Full
GET /api/v1/Project/{id}/Guide?$options=GrandTotal=true
GET /api/v1/Project/{id}/Guide?$context=illo
GET /api/v1/Project/{id}/Guide?$format=JSON
GET /api/v1/Project/{id}/Guide?$jsonSafe=False
GET /api/v1/Project/{id}/Guide?$output=Display

Request Headers

Parameter Name Description
Authorization Supports 'Basic', 'SoTicket' and 'Bearer' schemes, depending on installation type.
X-XSRF-TOKEN If not using Authorization header, you must provide XSRF value from cookie or hidden input field
Accept Content-type(s) you would like the response in: application/json, text/json, application/xml, text/xml, application/json-patch+json, application/merge-patch+json
Accept-Language Convert string references and multi-language values into a specified language (iso2) code.
SO-Language Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.
SO-Culture Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.
SO-TimeZone Specify the timezone code that you would like date/time responses converted to.
SO-AppToken The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Response:

OK

Response Description
200 OK
404 Not Found.

Response body: ODataSlimResponse

Property Name Type Description
odata.metadata string
odata.nextLink string
value array

Sample request

GET /api/v1/Project/{id}/Guide
Authorization: Basic dGplMDpUamUw
Accept: application/json; charset=utf-8
Accept-Language: fr,de,ru,zh

Sample response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "odata.metadata": "https://www.example.com/api/v1/archive$metadata",
  "odata.nextLink": "corporis",
  "value": [
    {
      "PrimaryKey": 2796,
      "EntityName": "sale",
      "saleId": 2796,
      "contactId": 3979,
      "name": "Roob, Wuckert and Moore"
    },
    {
      "PrimaryKey": 5467,
      "EntityName": "sale",
      "saleId": 5467,
      "contactId": 3020,
      "name": "Bayer, Kozey and Cremin"
    }
  ]
}