Get Archive_ G E T

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Archive/{archiveProviderName}");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/Archive/{archiveProviderName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Archive/{archiveProviderName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/Archive/{archiveProviderName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "odata.metadata": "<string>",
  "odata.nextLink": "<string>",
  "value": [
    {}
  ]
}

Get Archive_ G E T

Returns archive providers in OData format. Supports JSON and ATOM+XML results based on Accept headers. Supports OData query parameters: <ul><li>$select=col1,col2,abc/col3</li><li>$filter=col1 eq 'foo' and startswith(col2, 'baz')</li><li>$orderby=col1,abc/col3</li><li>$top=1000</li><li>$options=GrandTotal=true</li><li>$context=foo</li><li>$format=json</li></ul> ## 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) OData returns XML or JSON carriers depending on the Accept headers. $format can also be used to control the response format via the URL. <h2>Aggregation operators</h2> The column names can encode grouping and summarizing. You add functions and modifiers to the column name to trigger aggregation. <list type="bullet">* <description>GroupBy(col)</description> * <description>Sum(col)</description> * <description>Avg(col)</description> * <description>Percent(col)</description> * <description>Count(col)</description> * <description>CountAll(col)</description> * <description>DatePart(col)</description> You add modifiers to the end of the column name to trigger aggregation. <list type="bullet">* <description>:Header</description> * <description>:Footer</description> * <description>:HideDetail</description> DatePart specific modifiers <list type="bullet">* <description>:Year</description> * <description>:Quarter</description> * <description>:Month</description> * <description>:Day</description> * <description>:DayOfYear</description> * <description>:DayOfWeek</description> * <description>:Hour</description> * <description>:Weekno</description> * <description>:YearMonth</description> * <description>:YearWeekno</description> * <description>:YearQuarter</description> Example: group last names together, and inject a header row for each group. <code> GroupBy(lastName):Header </code> Example: count instances of middle names, and hide the individual rows, report just the totals for each group using a footer. Note how the modifiers stack. <code> Count(middleName):HideDetail:Footer </code> Example: the aggregator functions can nest, so you can say <code> GroupBy(DatePart(personUpdatedDate):YearMonth):Header </code> Some simple queries can be used to filter and simplify the result list: <code> GET api/archives/$metadata GET api/archives/findContact GET api/archives/findContact?$top=20 GET api/archives/findContact?$select=nameDepartment,fullname GET api/archives/findContact?$filter=name begins 'foo' GET api/archives/findContact?$filter=thisAndPrevious(registered, 2, 'weeks') GET api/archives/findContact?$select=nameDepartment,fullname&$filter=name begins 'foo' </code>

Get Archive_ G E T

using RestSharp;


var options = new RestClientOptions("http://localhost:56350/api/v1/Archive/{archiveProviderName}");
var client = new RestClient(options);
var request = new RestRequest("");
var response = await client.GetAsync(request);

Console.WriteLine("{0}", response.Content);

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/Archive/{archiveProviderName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "56350",
  CURLOPT_URL => "http://localhost:56350/api/v1/Archive/{archiveProviderName}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

const options = {method: 'GET'};

fetch('http://localhost:56350/api/v1/Archive/{archiveProviderName}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "odata.metadata": "<string>",
  "odata.nextLink": "<string>",
  "value": [
    {}
  ]
}

Headers

Accept-Language

string

Convert string references and multi-language values into a specified language (iso2) code.

SO-Language

string

Convert string references and multi-language values into a specified language (iso2) code. Overrides Accept-Language value.

SO-Culture

string

Number, date formatting in a specified culture (iso2 language) code. Partially overrides SO-Language/Accept-Language value. Ignored if no Language set.

SO-TimeZone

string

Specify the timezone code that you would like date/time responses converted to.

SO-AppToken

string

The application token that identifies the partner app. Used when calling Online WebAPI from a server.

Path Parameters

archiveProviderName

string

required

Archive Provider name: FindContact, Person, Product, etc. Call with blank name to get a list of names.

Query Parameters

$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 = "", which means all entities. "contact, person"

$top

integer<int32>

Number of rows to return in results.

$skip

integer<int32>

Number of rows to skip before returning results.

$mode

enum<string>

FULL (with raw values and hints for each value) or SLIM (just the display values)

Available options:

Slim,

Wide,

Full

$options

string

Provider specific options. e.g: "GrandTotal=true"

$context

string

Provider specific context parameter. Usually blank.

$format

string

Set XML or JSON output format, override the format determined from Accept header.

$metadata

string

Default: "ALL" to return description of all columns. Overrides $select and other parameters.

$inlineCount

enum<string>

Determine how/if row count is returned in the result

Available options:

False,

Estimate,

True,

AllPages

$jsonSafe

boolean

Make output names into JSON safe property names. Replace all unsafe characters with _ underscore.

$output

enum<string>

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.

Available options:

Logical,

Display

Response

Easy to use archive results - just a flat list of values.

odata.metadata

string

odata.nextLink

string

value

object[]

Show child attributes