POST api/v1/{entity}/{id}

This is a method that returns specific entity instance in JSON format based on body request and provided {id}.

Request Information

URI Parameters

Name	Description	Type	Additional information
entity	A entity name that allows you to search for its instances. Entity name is case insensitive.	string	Required
id	A specific entity ID	integer	Required

Body Parameters

A request body params that will filter more deeply queried entity instances.

BoApiRequestEntities

Name	Description	Type	Additional information
Settings	A encrypted value that contains sensitive information required to make api calls.	string	None.
LanguageID	A language in which response data will be returned.	string	None.
Fields	Fields that will be returned in response by querying specific entity. Fields are defined in the form of a list.	Collection of string	None.
RelatedFields	The fields of the linked entities are written in JSON format in the form: {"[Entity1]": "[Entity1].[FieldName1],[Entity1].[FieldName2]", "[Entity2]": "[Entity2].[FieldName1]"...}.	Object	None.
Filters	Filters can more deeply filter requested data by applying custom rules. Filters contain specific syntax that must be followed in order for the data to be filtered correctly. The syntax is as follows: { "AND"/"OR": [ [ { "FIELD1": { "is": "123" } }, { "FIELD2": { "ilike": "%abc%" } } ] ], "AND" / "OR": [ [ { "FIELD3": { "in": "127999" } } ] ] } Supported equality operators are: IN, ILIKE, ISNOT, LTE, GTE, LT, GT, IS	Object	None.
FilterByActivePeriods	It will additionally filter each instance retrieved by the request with the corresponding active period set on the specific instance.	boolean	None.
MediaTypes	Will return all media data that any entity instance contains for specified media types. Media types are defined in the form of a list.	Collection of string	None.
Sort	All returned data can be sort by specifing fields to sort. Sorting can only be possible for main entities, not related entities. Sorting is defined in the form of a JSON list by specifing name of field and direction as "ASC" for ascending and "DESC" for descending: [{"Field": "Field1,"Direction": "ASC/DESC"},{"Field": "Field2","Direction": "ASC/DESC"}]	Collection of BoApiRequestParamSort	None.
Paging	Pagination functionality used to get virtually paginate data by combining elements: Total, Offset, Limit. Pagination example for 2 virtual pages: { "Total": 6, "Offset": 0, "Limit": 3}	BoApiRequestParamPaging	None.
RequestUUID		string	None.
PageUUID		string	None.

Request Formats

application/json, text/json

Sample:

{
  "Settings": "sample string 1",
  "LanguageID": "sample string 2",
  "Fields": [
    "sample string 1",
    "sample string 2"
  ],
  "RelatedFields": {},
  "Filters": {},
  "FilterByActivePeriods": true,
  "MediaTypes": [
    "sample string 1",
    "sample string 2"
  ],
  "Sort": [
    {
      "Field": "sample string 1",
      "Direction": "sample string 2"
    },
    {
      "Field": "sample string 1",
      "Direction": "sample string 2"
    }
  ],
  "Paging": {
    "Total": 1,
    "Offset": 2,
    "Limit": 3
  },
  "RequestUUID": "sample string 6",
  "PageUUID": "sample string 7"
}

application/xml, text/xml

Sample:

<BoApiRequestEntities xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Infosit.ContentDelivery.Service.Bo">
  <PageUUID xmlns="http://schemas.datacontract.org/2004/07/Infosit.API.Common.Bo">sample string 7</PageUUID>
  <RequestUUID xmlns="http://schemas.datacontract.org/2004/07/Infosit.API.Common.Bo">sample string 6</RequestUUID>
  <Fields xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Fields>
  <FilterByActivePeriods>true</FilterByActivePeriods>
  <Filters />
  <LanguageID>sample string 2</LanguageID>
  <MediaTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </MediaTypes>
  <Paging>
    <Limit>3</Limit>
    <Offset>2</Offset>
    <Total>1</Total>
  </Paging>
  <RelatedFields />
  <Settings>sample string 1</Settings>
  <Sort>
    <BoApiRequestParamSort>
      <Direction>sample string 2</Direction>
      <Field>sample string 1</Field>
    </BoApiRequestParamSort>
    <BoApiRequestParamSort>
      <Direction>sample string 2</Direction>
      <Field>sample string 1</Field>
    </BoApiRequestParamSort>
  </Sort>
</BoApiRequestEntities>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage

Name	Type	Additional information
Version	Version	None.
Content	HttpContent	None.
StatusCode	HttpStatusCode	None.
ReasonPhrase	string	None.
Headers	Collection of Object	None.
RequestMessage	HttpRequestMessage	None.
IsSuccessStatusCode	boolean	None.