Pimics Publication API OData specification

apicategoryroutes.apicategoryroutes

apicategoryroutes.apicategoryroutes.ListApicategoryroutes

Get entities from apicategoryroutes

Request

GET /apicategoryroutes[?$top&$skip&$search&$filter&$count&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

apicategoryroutes.apicategoryroutes.GetApicategoryroutes

Get entity from apicategoryroutes by key

Request

GET /apicategoryroutes({route})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*route			key: route of apicategoryroutes
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.apicategoryroutes	Retrieved entity
default	odata.error	error

categories.category

categories.category.ListCategory

Get entities from categories

Request

GET /categories[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

categories.category.GetCategory

Get entity from categories by key

Request

GET /categories({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved entity
default	odata.error	error

categories.category.GetMainPictureSource

Get media content for category from categories

Request

GET /categories({id})/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of category

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

categories.content

categories.ListContents

Get contents from categories

Request

GET /categories({id})/contents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateContents

Create new navigation property to contents for categories

Request

POST /categories({id})/contents

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.content		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.content	Created navigation property.
default	odata.error	error

categories.GetContents

Get contents from categories

Request

GET /categories({id})/contents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.content	Retrieved navigation property
default	odata.error	error

categories.UpdateContents

Update the navigation property contents in categories

Request

PATCH /categories({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of content
*body	Microsoft.NAV.content		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteContents

Delete navigation property contents for categories

Request

DELETE /categories({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of content
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.defaultTranslation

categories.ListDefaultTranslations

Get defaultTranslations from categories

Request

GET /categories({id})/defaultTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateDefaultTranslations

Create new navigation property to defaultTranslations for categories

Request

POST /categories({id})/defaultTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.defaultTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.defaultTranslation	Created navigation property.
default	odata.error	error

categories.GetDefaultTranslations

Get defaultTranslations from categories

Request

GET /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.defaultTranslation	Retrieved navigation property
default	odata.error	error

categories.UpdateDefaultTranslations

Update the navigation property defaultTranslations in categories

Request

PATCH /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.defaultTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteDefaultTranslations

Delete navigation property defaultTranslations for categories

Request

DELETE /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.document

categories.ListDocuments

Get documents from categories

Request

GET /categories({id})/documents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateDocuments

Create new navigation property to documents for categories

Request

POST /categories({id})/documents

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.document		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.document	Created navigation property.
default	odata.error	error

categories.GetDocuments

Get documents from categories

Request

GET /categories({id})/documents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

categories.UpdateDocuments

Update the navigation property documents in categories

Request

PATCH /categories({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of document
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteDocuments

Delete navigation property documents for categories

Request

DELETE /categories({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.documentSource

categories.ListDocumentsSources

Get documentsSources from categories

Request

GET /categories({id})/documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateDocumentsSources

Create new navigation property to documentsSources for categories

Request

POST /categories({id})/documentsSources

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.documentSource		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created navigation property.
default	odata.error	error

categories.GetDocumentsSources

Get documentsSources from categories

Request

GET /categories({id})/documentsSources({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved navigation property
default	odata.error	error

categories.UpdateDocumentsSources

Update the navigation property documentsSources in categories

Request

PATCH /categories({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of documentSource
*body	Microsoft.NAV.documentSource		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteDocumentsSources

Delete navigation property documentsSources for categories

Request

DELETE /categories({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of documentSource
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.feature

categories.ListFeatures

Get features from categories

Request

GET /categories({id})/features[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateFeatures

Create new navigation property to features for categories

Request

POST /categories({id})/features

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.feature		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.feature	Created navigation property.
default	odata.error	error

categories.GetFeatures

Get features from categories

Request

GET /categories({id})/features({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.feature	Retrieved navigation property
default	odata.error	error

categories.UpdateFeatures

Update the navigation property features in categories

Request

PATCH /categories({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of feature
*body	Microsoft.NAV.feature		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteFeatures

Delete navigation property features for categories

Request

DELETE /categories({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of feature
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.item

categories.ListItems

Get items from categories

Request

GET /categories({id})/items[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateItems

Create new navigation property to items for categories

Request

POST /categories({id})/items

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.item		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.item	Created navigation property.
default	odata.error	error

categories.GetItems

Get items from categories

Request

GET /categories({id})/items({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of item
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

categories.UpdateItems

Update the navigation property items in categories

Request

PATCH /categories({id})/items({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of item
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteItems

Delete navigation property items for categories

Request

DELETE /categories({id})/items({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of item
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.GetItemsMainPictureSource

Get media content for the navigation property items from categories

Request

GET /categories({id})/items({id1})/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of item

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

categories.keyword

categories.ListKeywords

Get keywords from categories

Request

GET /categories({id})/keywords[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateKeywords

Create new navigation property to keywords for categories

Request

POST /categories({id})/keywords

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.keyword		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keyword	Created navigation property.
default	odata.error	error

categories.GetKeywords

Get keywords from categories

Request

GET /categories({id})/keywords({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keyword	Retrieved navigation property
default	odata.error	error

categories.UpdateKeywords

Update the navigation property keywords in categories

Request

PATCH /categories({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of keyword
*body	Microsoft.NAV.keyword		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteKeywords

Delete navigation property keywords for categories

Request

DELETE /categories({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of keyword
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.reference

categories.ListReferences

Get references from categories

Request

GET /categories({id})/references[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateReferences

Create new navigation property to references for categories

Request

POST /categories({id})/references

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.reference		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.reference	Created navigation property.
default	odata.error	error

categories.GetReferences

Get references from categories

Request

GET /categories({id})/references({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.reference	Retrieved navigation property
default	odata.error	error

categories.UpdateReferences

Update the navigation property references in categories

Request

PATCH /categories({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of reference
*body	Microsoft.NAV.reference		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteReferences

Delete navigation property references for categories

Request

DELETE /categories({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of reference
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.text

categories.ListTexts

Get texts from categories

Request

GET /categories({id})/texts[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

categories.CreateTexts

Create new navigation property to texts for categories

Request

POST /categories({id})/texts

Parameters

Name	Type	Default	Notes
*id			key: id of category
*body	Microsoft.NAV.text		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.text	Created navigation property.
default	odata.error	error

categories.GetTexts

Get texts from categories

Request

GET /categories({id})/texts({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved navigation property
default	odata.error	error

categories.UpdateTexts

Update the navigation property texts in categories

Request

PATCH /categories({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of text
*body	Microsoft.NAV.text		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.DeleteTexts

Delete navigation property texts for categories

Request

DELETE /categories({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

categories.GetTextsSource

Get media content for the navigation property texts from categories

Request

GET /categories({id})/texts({id1})/source

Parameters

Name	Type	Default	Notes
*id			key: id of category
*id1			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

changedLines.changedLine

changedLines.changedLine.ListChangedLine

Get entities from changedLines

Request

GET /changedLines[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

changedLines.changedLine.CreateChangedLine

Add new entity to changedLines

Request

POST /changedLines

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.changedLine		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.changedLine	Created entity
default	odata.error	error

changedLines.changedLine.GetChangedLine

Get entity from changedLines by key

Request

GET /changedLines({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of changedLine
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.changedLine	Retrieved entity
default	odata.error	error

companies.company

companies.company.ListCompany

Get entities from companies

Request

GET /companies[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

companies.company.GetCompany

Get entity from companies by key

Request

GET /companies({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.company	Retrieved entity
default	odata.error	error

companies.category

companies.ListCategories

Get categories from companies

Request

GET /companies({id})/categories[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateCategories

Create new navigation property to categories for companies

Request

POST /companies({id})/categories

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.category		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.category	Created navigation property.
default	odata.error	error

companies.GetCategories

Get categories from companies

Request

GET /companies({id})/categories({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of category
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

companies.UpdateCategories

Update the navigation property categories in companies

Request

PATCH /companies({id})/categories({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of category
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteCategories

Delete navigation property categories for companies

Request

DELETE /companies({id})/categories({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of category
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.GetCategoriesMainPictureSource

Get media content for the navigation property categories from companies

Request

GET /companies({id})/categories({id1})/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of category

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

companies.changedLine

companies.ListChangedLines

Get changedLines from companies

Request

GET /companies({id})/changedLines[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateChangedLines

Create new navigation property to changedLines for companies

Request

POST /companies({id})/changedLines

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.changedLine		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.changedLine	Created navigation property.
default	odata.error	error

companies.GetChangedLines

Get changedLines from companies

Request

GET /companies({id})/changedLines({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of changedLine
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.changedLine	Retrieved navigation property
default	odata.error	error

companies.UpdateChangedLines

Update the navigation property changedLines in companies

Request

PATCH /companies({id})/changedLines({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of changedLine
*body	Microsoft.NAV.changedLine		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteChangedLines

Delete navigation property changedLines for companies

Request

DELETE /companies({id})/changedLines({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of changedLine
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.content

companies.ListContents

Get contents from companies

Request

GET /companies({id})/contents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateContents

Create new navigation property to contents for companies

Request

POST /companies({id})/contents

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.content		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.content	Created navigation property.
default	odata.error	error

companies.GetContents

Get contents from companies

Request

GET /companies({id})/contents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.content	Retrieved navigation property
default	odata.error	error

companies.UpdateContents

Update the navigation property contents in companies

Request

PATCH /companies({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of content
*body	Microsoft.NAV.content		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteContents

Delete navigation property contents for companies

Request

DELETE /companies({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of content
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.defaultTranslation

companies.ListDefaultTranslations

Get defaultTranslations from companies

Request

GET /companies({id})/defaultTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateDefaultTranslations

Create new navigation property to defaultTranslations for companies

Request

POST /companies({id})/defaultTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.defaultTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.defaultTranslation	Created navigation property.
default	odata.error	error

companies.GetDefaultTranslations

Get defaultTranslations from companies

Request

GET /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.defaultTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateDefaultTranslations

Update the navigation property defaultTranslations in companies

Request

PATCH /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.defaultTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteDefaultTranslations

Delete navigation property defaultTranslations for companies

Request

DELETE /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.deletedLine

companies.ListDeletedLines

Get deletedLines from companies

Request

GET /companies({id})/deletedLines[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateDeletedLines

Create new navigation property to deletedLines for companies

Request

POST /companies({id})/deletedLines

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.deletedLine		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.deletedLine	Created navigation property.
default	odata.error	error

companies.GetDeletedLines

Get deletedLines from companies

Request

GET /companies({id})/deletedLines({logId})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*logId			key: logId of deletedLine
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.deletedLine	Retrieved navigation property
default	odata.error	error

companies.UpdateDeletedLines

Update the navigation property deletedLines in companies

Request

PATCH /companies({id})/deletedLines({logId})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*logId			key: logId of deletedLine
*body	Microsoft.NAV.deletedLine		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteDeletedLines

Delete navigation property deletedLines for companies

Request

DELETE /companies({id})/deletedLines({logId})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*logId			key: logId of deletedLine
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.document

companies.ListDocuments

Get documents from companies

Request

GET /companies({id})/documents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateDocuments

Create new navigation property to documents for companies

Request

POST /companies({id})/documents

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.document		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.document	Created navigation property.
default	odata.error	error

companies.GetDocuments

Get documents from companies

Request

GET /companies({id})/documents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

companies.UpdateDocuments

Update the navigation property documents in companies

Request

PATCH /companies({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of document
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteDocuments

Delete navigation property documents for companies

Request

DELETE /companies({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.documentSource

companies.ListDocumentsSources

Get documentsSources from companies

Request

GET /companies({id})/documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateDocumentsSources

Create new navigation property to documentsSources for companies

Request

POST /companies({id})/documentsSources

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.documentSource		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created navigation property.
default	odata.error	error

companies.GetDocumentsSources

Get documentsSources from companies

Request

GET /companies({id})/documentsSources({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved navigation property
default	odata.error	error

companies.UpdateDocumentsSources

Update the navigation property documentsSources in companies

Request

PATCH /companies({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of documentSource
*body	Microsoft.NAV.documentSource		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteDocumentsSources

Delete navigation property documentsSources for companies

Request

DELETE /companies({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of documentSource
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.documentTranslation

companies.ListDocumentTranslations

Get documentTranslations from companies

Request

GET /companies({id})/documentTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateDocumentTranslations

Create new navigation property to documentTranslations for companies

Request

POST /companies({id})/documentTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.documentTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentTranslation	Created navigation property.
default	odata.error	error

companies.GetDocumentTranslations

Get documentTranslations from companies

Request

GET /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateDocumentTranslations

Update the navigation property documentTranslations in companies

Request

PATCH /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
*body	Microsoft.NAV.documentTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteDocumentTranslations

Delete navigation property documentTranslations for companies

Request

DELETE /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.feature

companies.ListFeatures

Get features from companies

Request

GET /companies({id})/features[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateFeatures

Create new navigation property to features for companies

Request

POST /companies({id})/features

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.feature		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.feature	Created navigation property.
default	odata.error	error

companies.GetFeatures

Get features from companies

Request

GET /companies({id})/features({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.feature	Retrieved navigation property
default	odata.error	error

companies.UpdateFeatures

Update the navigation property features in companies

Request

PATCH /companies({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of feature
*body	Microsoft.NAV.feature		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteFeatures

Delete navigation property features for companies

Request

DELETE /companies({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of feature
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.featureValue

companies.ListFeaturesValues

Get featuresValues from companies

Request

GET /companies({id})/featuresValues[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateFeaturesValues

Create new navigation property to featuresValues for companies

Request

POST /companies({id})/featuresValues

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.featureValue		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureValue	Created navigation property.
default	odata.error	error

companies.GetFeaturesValues

Get featuresValues from companies

Request

GET /companies({id})/featuresValues({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValue
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValue	Retrieved navigation property
default	odata.error	error

companies.UpdateFeaturesValues

Update the navigation property featuresValues in companies

Request

PATCH /companies({id})/featuresValues({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValue
*body	Microsoft.NAV.featureValue		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteFeaturesValues

Delete navigation property featuresValues for companies

Request

DELETE /companies({id})/featuresValues({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValue
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.featureTranslation

companies.ListFeatureTranslations

Get featureTranslations from companies

Request

GET /companies({id})/featureTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateFeatureTranslations

Create new navigation property to featureTranslations for companies

Request

POST /companies({id})/featureTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.featureTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureTranslation	Created navigation property.
default	odata.error	error

companies.GetFeatureTranslations

Get featureTranslations from companies

Request

GET /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateFeatureTranslations

Update the navigation property featureTranslations in companies

Request

PATCH /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
*body	Microsoft.NAV.featureTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteFeatureTranslations

Delete navigation property featureTranslations for companies

Request

DELETE /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.featureValueSet

companies.ListFeatureValueSets

Get featureValueSets from companies

Request

GET /companies({id})/featureValueSets[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateFeatureValueSets

Create new navigation property to featureValueSets for companies

Request

POST /companies({id})/featureValueSets

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.featureValueSet		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureValueSet	Created navigation property.
default	odata.error	error

companies.GetFeatureValueSets

Get featureValueSets from companies

Request

GET /companies({id})/featureValueSets({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValueSet
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValueSet	Retrieved navigation property
default	odata.error	error

companies.UpdateFeatureValueSets

Update the navigation property featureValueSets in companies

Request

PATCH /companies({id})/featureValueSets({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValueSet
*body	Microsoft.NAV.featureValueSet		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteFeatureValueSets

Delete navigation property featureValueSets for companies

Request

DELETE /companies({id})/featureValueSets({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of featureValueSet
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.htmlContent

companies.ListHtmlContents

Get htmlContents from companies

Request

GET /companies({id})/htmlContents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateHtmlContents

Create new navigation property to htmlContents for companies

Request

POST /companies({id})/htmlContents

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.htmlContent		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.htmlContent	Created navigation property.
default	odata.error	error

companies.GetHtmlContents

Get htmlContents from companies

Request

GET /companies({id})/htmlContents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of htmlContent
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.htmlContent	Retrieved navigation property
default	odata.error	error

companies.UpdateHtmlContents

Update the navigation property htmlContents in companies

Request

PATCH /companies({id})/htmlContents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of htmlContent
*body	Microsoft.NAV.htmlContent		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteHtmlContents

Delete navigation property htmlContents for companies

Request

DELETE /companies({id})/htmlContents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of htmlContent
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.item

companies.ListItems

Get items from companies

Request

GET /companies({id})/items[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateItems

Create new navigation property to items for companies

Request

POST /companies({id})/items

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.item		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.item	Created navigation property.
default	odata.error	error

companies.GetItems

Get items from companies

Request

GET /companies({id})/items({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of item
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

companies.UpdateItems

Update the navigation property items in companies

Request

PATCH /companies({id})/items({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of item
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteItems

Delete navigation property items for companies

Request

DELETE /companies({id})/items({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of item
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.GetItemsMainPictureSource

Get media content for the navigation property items from companies

Request

GET /companies({id})/items({id1})/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of item

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

companies.keyword

companies.ListKeywords

Get keywords from companies

Request

GET /companies({id})/keywords[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateKeywords

Create new navigation property to keywords for companies

Request

POST /companies({id})/keywords

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.keyword		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keyword	Created navigation property.
default	odata.error	error

companies.GetKeywords

Get keywords from companies

Request

GET /companies({id})/keywords({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keyword	Retrieved navigation property
default	odata.error	error

companies.UpdateKeywords

Update the navigation property keywords in companies

Request

PATCH /companies({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of keyword
*body	Microsoft.NAV.keyword		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteKeywords

Delete navigation property keywords for companies

Request

DELETE /companies({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of keyword
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.keywordTranslation

companies.ListKeywordTranslations

Get keywordTranslations from companies

Request

GET /companies({id})/keywordTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateKeywordTranslations

Create new navigation property to keywordTranslations for companies

Request

POST /companies({id})/keywordTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.keywordTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keywordTranslation	Created navigation property.
default	odata.error	error

companies.GetKeywordTranslations

Get keywordTranslations from companies

Request

GET /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keywordTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateKeywordTranslations

Update the navigation property keywordTranslations in companies

Request

PATCH /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
*body	Microsoft.NAV.keywordTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteKeywordTranslations

Delete navigation property keywordTranslations for companies

Request

DELETE /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.price

companies.ListPrices

Get prices from companies

Request

GET /companies({id})/prices[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreatePrices

Create new navigation property to prices for companies

Request

POST /companies({id})/prices

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.price		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.price	Created navigation property.
default	odata.error	error

companies.GetPrices

Get prices from companies

Request

GET /companies({id})/prices({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of price
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.price	Retrieved navigation property
default	odata.error	error

companies.UpdatePrices

Update the navigation property prices in companies

Request

PATCH /companies({id})/prices({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of price
*body	Microsoft.NAV.price		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeletePrices

Delete navigation property prices for companies

Request

DELETE /companies({id})/prices({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of price
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.reference

companies.ListReferences

Get references from companies

Request

GET /companies({id})/references[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateReferences

Create new navigation property to references for companies

Request

POST /companies({id})/references

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.reference		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.reference	Created navigation property.
default	odata.error	error

companies.GetReferences

Get references from companies

Request

GET /companies({id})/references({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.reference	Retrieved navigation property
default	odata.error	error

companies.UpdateReferences

Update the navigation property references in companies

Request

PATCH /companies({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of reference
*body	Microsoft.NAV.reference		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteReferences

Delete navigation property references for companies

Request

DELETE /companies({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of reference
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.text

companies.ListTexts

Get texts from companies

Request

GET /companies({id})/texts[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateTexts

Create new navigation property to texts for companies

Request

POST /companies({id})/texts

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.text		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.text	Created navigation property.
default	odata.error	error

companies.GetTexts

Get texts from companies

Request

GET /companies({id})/texts({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved navigation property
default	odata.error	error

companies.UpdateTexts

Update the navigation property texts in companies

Request

PATCH /companies({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of text
*body	Microsoft.NAV.text		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteTexts

Delete navigation property texts for companies

Request

DELETE /companies({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.GetTextsSource

Get media content for the navigation property texts from companies

Request

GET /companies({id})/texts({id1})/source

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

companies.textTranslation

companies.ListTextTranslations

Get textTranslations from companies

Request

GET /companies({id})/textTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateTextTranslations

Create new navigation property to textTranslations for companies

Request

POST /companies({id})/textTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.textTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.textTranslation	Created navigation property.
default	odata.error	error

companies.GetTextTranslations

Get textTranslations from companies

Request

GET /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.textTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateTextTranslations

Update the navigation property textTranslations in companies

Request

PATCH /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
*body	Microsoft.NAV.textTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteTextTranslations

Delete navigation property textTranslations for companies

Request

DELETE /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.valueTranslation

companies.ListValueTranslations

Get valueTranslations from companies

Request

GET /companies({id})/valueTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateValueTranslations

Create new navigation property to valueTranslations for companies

Request

POST /companies({id})/valueTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.valueTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.valueTranslation	Created navigation property.
default	odata.error	error

companies.GetValueTranslations

Get valueTranslations from companies

Request

GET /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.valueTranslation	Retrieved navigation property
default	odata.error	error

companies.UpdateValueTranslations

Update the navigation property valueTranslations in companies

Request

PATCH /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
*body	Microsoft.NAV.valueTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteValueTranslations

Delete navigation property valueTranslations for companies

Request

DELETE /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.variant

companies.ListVariants

Get variants from companies

Request

GET /companies({id})/variants[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

companies.CreateVariants

Create new navigation property to variants for companies

Request

POST /companies({id})/variants

Parameters

Name	Type	Default	Notes
*id			key: id of company
*body	Microsoft.NAV.variant		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.variant	Created navigation property.
default	odata.error	error

companies.GetVariants

Get variants from companies

Request

GET /companies({id})/variants({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of variant
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.variant	Retrieved navigation property
default	odata.error	error

companies.UpdateVariants

Update the navigation property variants in companies

Request

PATCH /companies({id})/variants({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of variant
*body	Microsoft.NAV.variant		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

companies.DeleteVariants

Delete navigation property variants for companies

Request

DELETE /companies({id})/variants({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of company
*id1			key: id of variant
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

contents.content

contents.content.ListContent

Get entities from contents

Request

GET /contents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

contents.content.GetContent

Get entity from contents by key

Request

GET /contents({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.content	Retrieved entity
default	odata.error	error

contents.category

contents.GetCategory

Get category from contents

Request

GET /contents({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

contents.UpdateCategory

Update the navigation property category in contents

Request

PATCH /contents({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of content
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

contents.DeleteCategory

Delete navigation property category for contents

Request

DELETE /contents({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of content
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

contents.GetCategoryMainPictureSource

Get media content for the navigation property category from contents

Request

GET /contents({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of content

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

contents.item

contents.GetItem

Get item from contents

Request

GET /contents({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

contents.UpdateItem

Update the navigation property item in contents

Request

PATCH /contents({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of content
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

contents.DeleteItem

Delete navigation property item for contents

Request

DELETE /contents({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of content
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

contents.GetItemMainPictureSource

Get media content for the navigation property item from contents

Request

GET /contents({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of content

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

defaultTranslations.defaultTranslation

defaultTranslations.defaultTranslation.ListDefaultTranslation

Get entities from defaultTranslations

Request

GET /defaultTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

defaultTranslations.defaultTranslation.CreateDefaultTranslation

Add new entity to defaultTranslations

Request

POST /defaultTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.defaultTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.defaultTranslation	Created entity
default	odata.error	error

defaultTranslations.defaultTranslation.GetDefaultTranslation

Get entity from defaultTranslations by key

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.defaultTranslation	Retrieved entity
default	odata.error	error

defaultTranslations.category

defaultTranslations.GetCategory

Get category from defaultTranslations

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

defaultTranslations.UpdateCategory

Update the navigation property category in defaultTranslations

Request

PATCH /defaultTranslations(lineGuid={lineGuid},lang={lang})/category

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

defaultTranslations.DeleteCategory

Delete navigation property category for defaultTranslations

Request

DELETE /defaultTranslations(lineGuid={lineGuid},lang={lang})/category

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

defaultTranslations.GetCategoryMainPictureSource

Get media content for the navigation property category from defaultTranslations

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

defaultTranslations.item

defaultTranslations.GetItem

Get item from defaultTranslations

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

defaultTranslations.UpdateItem

Update the navigation property item in defaultTranslations

Request

PATCH /defaultTranslations(lineGuid={lineGuid},lang={lang})/item

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

defaultTranslations.DeleteItem

Delete navigation property item for defaultTranslations

Request

DELETE /defaultTranslations(lineGuid={lineGuid},lang={lang})/item

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

defaultTranslations.GetItemMainPictureSource

Get media content for the navigation property item from defaultTranslations

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

defaultTranslations.reference

defaultTranslations.GetReference

Get reference from defaultTranslations

Request

GET /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.reference	Retrieved navigation property
default	odata.error	error

defaultTranslations.UpdateReference

Update the navigation property reference in defaultTranslations

Request

PATCH /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.reference		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

defaultTranslations.DeleteReference

Delete navigation property reference for defaultTranslations

Request

DELETE /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

deletedLines.deletedLine

deletedLines.deletedLine.ListDeletedLine

Get entities from deletedLines

Request

GET /deletedLines[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

deletedLines.deletedLine.CreateDeletedLine

Add new entity to deletedLines

Request

POST /deletedLines

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.deletedLine		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.deletedLine	Created entity
default	odata.error	error

deletedLines.deletedLine.GetDeletedLine

Get entity from deletedLines by key

Request

GET /deletedLines({logId})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*logId			key: logId of deletedLine
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.deletedLine	Retrieved entity
default	odata.error	error

documents.document

documents.document.ListDocument

Get entities from documents

Request

GET /documents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

documents.document.GetDocument

Get entity from documents by key

Request

GET /documents({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved entity
default	odata.error	error

documents.category

documents.GetCategory

Get category from documents

Request

GET /documents({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

documents.UpdateCategory

Update the navigation property category in documents

Request

PATCH /documents({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteCategory

Delete navigation property category for documents

Request

DELETE /documents({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.GetCategoryMainPictureSource

Get media content for the navigation property category from documents

Request

GET /documents({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of document

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

documents.documentSource

documents.ListDocumentsSources

Get documentsSources from documents

Request

GET /documents({id})/documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

documents.CreateDocumentsSources

Create new navigation property to documentsSources for documents

Request

POST /documents({id})/documentsSources

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.documentSource		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created navigation property.
default	odata.error	error

documents.GetDocumentsSources

Get documentsSources from documents

Request

GET /documents({id})/documentsSources({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved navigation property
default	odata.error	error

documents.UpdateDocumentsSources

Update the navigation property documentsSources in documents

Request

PATCH /documents({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of documentSource
*body	Microsoft.NAV.documentSource		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteDocumentsSources

Delete navigation property documentsSources for documents

Request

DELETE /documents({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of documentSource
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.documentTranslation

documents.ListDocumentTranslations

Get documentTranslations from documents

Request

GET /documents({id})/documentTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

documents.CreateDocumentTranslations

Create new navigation property to documentTranslations for documents

Request

POST /documents({id})/documentTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.documentTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentTranslation	Created navigation property.
default	odata.error	error

documents.GetDocumentTranslations

Get documentTranslations from documents

Request

GET /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentTranslation	Retrieved navigation property
default	odata.error	error

documents.UpdateDocumentTranslations

Update the navigation property documentTranslations in documents

Request

PATCH /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
*body	Microsoft.NAV.documentTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteDocumentTranslations

Delete navigation property documentTranslations for documents

Request

DELETE /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.item

documents.GetItem

Get item from documents

Request

GET /documents({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

documents.UpdateItem

Update the navigation property item in documents

Request

PATCH /documents({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteItem

Delete navigation property item for documents

Request

DELETE /documents({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.GetItemMainPictureSource

Get media content for the navigation property item from documents

Request

GET /documents({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of document

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

documents.text

documents.ListTexts

Get texts from documents

Request

GET /documents({id})/texts[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

documents.CreateTexts

Create new navigation property to texts for documents

Request

POST /documents({id})/texts

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.text		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.text	Created navigation property.
default	odata.error	error

documents.GetTexts

Get texts from documents

Request

GET /documents({id})/texts({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved navigation property
default	odata.error	error

documents.UpdateTexts

Update the navigation property texts in documents

Request

PATCH /documents({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of text
*body	Microsoft.NAV.text		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteTexts

Delete navigation property texts for documents

Request

DELETE /documents({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.GetTextsSource

Get media content for the navigation property texts from documents

Request

GET /documents({id})/texts({id1})/source

Parameters

Name	Type	Default	Notes
*id			key: id of document
*id1			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

documents.variant

documents.GetVariant

Get variant from documents

Request

GET /documents({id})/variant[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.variant	Retrieved navigation property
default	odata.error	error

documents.UpdateVariant

Update the navigation property variant in documents

Request

PATCH /documents({id})/variant

Parameters

Name	Type	Default	Notes
*id			key: id of document
*body	Microsoft.NAV.variant		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documents.DeleteVariant

Delete navigation property variant for documents

Request

DELETE /documents({id})/variant

Parameters

Name	Type	Default	Notes
*id			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documentsSources.documentSource

documentsSources.documentSource.ListDocumentSource

Get entities from documentsSources

Request

GET /documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

documentsSources.documentSource.CreateDocumentSource

Add new entity to documentsSources

Request

POST /documentsSources

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.documentSource		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created entity
default	odata.error	error

documentsSources.documentSource.GetDocumentSource

Get entity from documentsSources by key

Request

GET /documentsSources({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved entity
default	odata.error	error

documentTranslations.documentTranslation

documentTranslations.documentTranslation.ListDocumentTranslation

Get entities from documentTranslations

Request

GET /documentTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

documentTranslations.documentTranslation.CreateDocumentTranslation

Add new entity to documentTranslations

Request

POST /documentTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.documentTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentTranslation	Created entity
default	odata.error	error

documentTranslations.documentTranslation.GetDocumentTranslation

Get entity from documentTranslations by key

Request

GET /documentTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentTranslation	Retrieved entity
default	odata.error	error

documentTranslations.document

documentTranslations.GetDocument

Get document from documentTranslations

Request

GET /documentTranslations(lineGuid={lineGuid},lang={lang})/document[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

documentTranslations.UpdateDocument

Update the navigation property document in documentTranslations

Request

PATCH /documentTranslations(lineGuid={lineGuid},lang={lang})/document

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

documentTranslations.DeleteDocument

Delete navigation property document for documentTranslations

Request

DELETE /documentTranslations(lineGuid={lineGuid},lang={lang})/document

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of documentTranslation
*lang			key: lang of documentTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

entityDefinitions.entityMetadata

entityDefinitions.entityMetadata.ListEntityMetadata

Get entities from entityDefinitions

Request

GET /entityDefinitions[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

entityDefinitions.entityMetadata.CreateEntityMetadata

Add new entity to entityDefinitions

Request

POST /entityDefinitions

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.entityMetadata		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.entityMetadata	Created entity
default	odata.error	error

entityDefinitions.entityMetadata.GetEntityMetadata

Get entity from entityDefinitions by key

Request

GET /entityDefinitions({entityName})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*entityName			key: entityName of entityMetadata
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.entityMetadata	Retrieved entity
default	odata.error	error

entityDefinitions.entityMetadata.UpdateEntityMetadata

Update entity in entityDefinitions

Request

PATCH /entityDefinitions({entityName})

Parameters

Name	Type	Default	Notes
*entityName			key: entityName of entityMetadata
*body	Microsoft.NAV.entityMetadata		New property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

entityDefinitions.entityMetadata.DeleteEntityMetadata

Delete entity from entityDefinitions

Request

DELETE /entityDefinitions({entityName})

Parameters

Name	Type	Default	Notes
*entityName			key: entityName of entityMetadata
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

externalbusinesseventdefinitions.externalbusinesseventdefinitions

externalbusinesseventdefinitions.externalbusinesseventdefinitions.ListExternalbusinesseventdefinitions

Get entities from externalbusinesseventdefinitions

Request

GET /externalbusinesseventdefinitions[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

externalbusinesseventdefinitions.externalbusinesseventdefinitions.GetExternalbusinesseventdefinitions

Get entity from externalbusinesseventdefinitions by key

Request

GET /externalbusinesseventdefinitions(appId={appId},name={name},eventVersion={eventVersion})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*appId			key: appId of externalbusinesseventdefinitions
*name			key: name of externalbusinesseventdefinitions
*eventVersion			key: eventVersion of externalbusinesseventdefinitions
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.externalbusinesseventdefinitions	Retrieved entity
default	odata.error	error

externaleventsubscriptions.externaleventsubscriptions

externaleventsubscriptions.externaleventsubscriptions.ListExternaleventsubscriptions

Get entities from externaleventsubscriptions

Request

GET /externaleventsubscriptions[?$top&$skip&$search&$filter&$count&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

externaleventsubscriptions.externaleventsubscriptions.CreateExternaleventsubscriptions

Add new entity to externaleventsubscriptions

Request

POST /externaleventsubscriptions

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.externaleventsubscriptions		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.externaleventsubscriptions	Created entity
default	odata.error	error

externaleventsubscriptions.externaleventsubscriptions.GetExternaleventsubscriptions

Get entity from externaleventsubscriptions by key

Request

GET /externaleventsubscriptions({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of externaleventsubscriptions
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.externaleventsubscriptions	Retrieved entity
default	odata.error	error

externaleventsubscriptions.externaleventsubscriptions.UpdateExternaleventsubscriptions

Update entity in externaleventsubscriptions

Request

PATCH /externaleventsubscriptions({id})

Parameters

Name	Type	Default	Notes
*id			key: id of externaleventsubscriptions
*body	Microsoft.NAV.externaleventsubscriptions		New property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

externaleventsubscriptions.externaleventsubscriptions.DeleteExternaleventsubscriptions

Delete entity from externaleventsubscriptions

Request

DELETE /externaleventsubscriptions({id})

Parameters

Name	Type	Default	Notes
*id			key: id of externaleventsubscriptions
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.feature

features.feature.ListFeature

Get entities from features

Request

GET /features[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

features.feature.GetFeature

Get entity from features by key

Request

GET /features({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.feature	Retrieved entity
default	odata.error	error

features.category

features.GetCategory

Get category from features

Request

GET /features({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

features.UpdateCategory

Update the navigation property category in features

Request

PATCH /features({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.DeleteCategory

Delete navigation property category for features

Request

DELETE /features({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of feature
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.GetCategoryMainPictureSource

Get media content for the navigation property category from features

Request

GET /features({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of feature

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

features.featureValue

features.ListFeaturesValues

Get featuresValues from features

Request

GET /features({id})/featuresValues[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

features.CreateFeaturesValues

Create new navigation property to featuresValues for features

Request

POST /features({id})/featuresValues

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*body	Microsoft.NAV.featureValue		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureValue	Created navigation property.
default	odata.error	error

features.GetFeaturesValues

Get featuresValues from features

Request

GET /features({id})/featuresValues({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValue
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValue	Retrieved navigation property
default	odata.error	error

features.UpdateFeaturesValues

Update the navigation property featuresValues in features

Request

PATCH /features({id})/featuresValues({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValue
*body	Microsoft.NAV.featureValue		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.DeleteFeaturesValues

Delete navigation property featuresValues for features

Request

DELETE /features({id})/featuresValues({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValue
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.featureTranslation

features.ListFeatureTranslations

Get featureTranslations from features

Request

GET /features({id})/featureTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

features.CreateFeatureTranslations

Create new navigation property to featureTranslations for features

Request

POST /features({id})/featureTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*body	Microsoft.NAV.featureTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureTranslation	Created navigation property.
default	odata.error	error

features.GetFeatureTranslations

Get featureTranslations from features

Request

GET /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureTranslation	Retrieved navigation property
default	odata.error	error

features.UpdateFeatureTranslations

Update the navigation property featureTranslations in features

Request

PATCH /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
*body	Microsoft.NAV.featureTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.DeleteFeatureTranslations

Delete navigation property featureTranslations for features

Request

DELETE /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.featureValueSet

features.ListFeatureValueSets

Get featureValueSets from features

Request

GET /features({id})/featureValueSets[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

features.CreateFeatureValueSets

Create new navigation property to featureValueSets for features

Request

POST /features({id})/featureValueSets

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*body	Microsoft.NAV.featureValueSet		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureValueSet	Created navigation property.
default	odata.error	error

features.GetFeatureValueSets

Get featureValueSets from features

Request

GET /features({id})/featureValueSets({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValueSet
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValueSet	Retrieved navigation property
default	odata.error	error

features.UpdateFeatureValueSets

Update the navigation property featureValueSets in features

Request

PATCH /features({id})/featureValueSets({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValueSet
*body	Microsoft.NAV.featureValueSet		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.DeleteFeatureValueSets

Delete navigation property featureValueSets for features

Request

DELETE /features({id})/featureValueSets({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*id1			key: id of featureValueSet
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.item

features.GetItem

Get item from features

Request

GET /features({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

features.UpdateItem

Update the navigation property item in features

Request

PATCH /features({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of feature
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.DeleteItem

Delete navigation property item for features

Request

DELETE /features({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of feature
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

features.GetItemMainPictureSource

Get media content for the navigation property item from features

Request

GET /features({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of feature

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

featuresValues.featureValue

featuresValues.featureValue.ListFeatureValue

Get entities from featuresValues

Request

GET /featuresValues[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

featuresValues.featureValue.GetFeatureValue

Get entity from featuresValues by key

Request

GET /featuresValues({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValue	Retrieved entity
default	odata.error	error

featuresValues.valueTranslation

featuresValues.ListValueTranslations

Get valueTranslations from featuresValues

Request

GET /featuresValues({id})/valueTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

featuresValues.CreateValueTranslations

Create new navigation property to valueTranslations for featuresValues

Request

POST /featuresValues({id})/valueTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
*body	Microsoft.NAV.valueTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.valueTranslation	Created navigation property.
default	odata.error	error

featuresValues.GetValueTranslations

Get valueTranslations from featuresValues

Request

GET /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.valueTranslation	Retrieved navigation property
default	odata.error	error

featuresValues.UpdateValueTranslations

Update the navigation property valueTranslations in featuresValues

Request

PATCH /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
*body	Microsoft.NAV.valueTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

featuresValues.DeleteValueTranslations

Delete navigation property valueTranslations for featuresValues

Request

DELETE /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of featureValue
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

featureTranslations.featureTranslation

featureTranslations.featureTranslation.ListFeatureTranslation

Get entities from featureTranslations

Request

GET /featureTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

featureTranslations.featureTranslation.CreateFeatureTranslation

Add new entity to featureTranslations

Request

POST /featureTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.featureTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.featureTranslation	Created entity
default	odata.error	error

featureTranslations.featureTranslation.GetFeatureTranslation

Get entity from featureTranslations by key

Request

GET /featureTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureTranslation	Retrieved entity
default	odata.error	error

featureTranslations.feature

featureTranslations.GetFeature

Get feature from featureTranslations

Request

GET /featureTranslations(lineGuid={lineGuid},lang={lang})/feature[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.feature	Retrieved navigation property
default	odata.error	error

featureTranslations.UpdateFeature

Update the navigation property feature in featureTranslations

Request

PATCH /featureTranslations(lineGuid={lineGuid},lang={lang})/feature

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
*body	Microsoft.NAV.feature		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

featureTranslations.DeleteFeature

Delete navigation property feature for featureTranslations

Request

DELETE /featureTranslations(lineGuid={lineGuid},lang={lang})/feature

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of featureTranslation
*lang			key: lang of featureTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

featureValueSets.featureValueSet

featureValueSets.featureValueSet.ListFeatureValueSet

Get entities from featureValueSets

Request

GET /featureValueSets[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

featureValueSets.featureValueSet.GetFeatureValueSet

Get entity from featureValueSets by key

Request

GET /featureValueSets({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.featureValueSet	Retrieved entity
default	odata.error	error

featureValueSets.valueTranslation

featureValueSets.ListValueTranslations

Get valueTranslations from featureValueSets

Request

GET /featureValueSets({id})/valueTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

featureValueSets.CreateValueTranslations

Create new navigation property to valueTranslations for featureValueSets

Request

POST /featureValueSets({id})/valueTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
*body	Microsoft.NAV.valueTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.valueTranslation	Created navigation property.
default	odata.error	error

featureValueSets.GetValueTranslations

Get valueTranslations from featureValueSets

Request

GET /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.valueTranslation	Retrieved navigation property
default	odata.error	error

featureValueSets.UpdateValueTranslations

Update the navigation property valueTranslations in featureValueSets

Request

PATCH /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
*body	Microsoft.NAV.valueTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

featureValueSets.DeleteValueTranslations

Delete navigation property valueTranslations for featureValueSets

Request

DELETE /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of featureValueSet
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

htmlContents.htmlContent

htmlContents.htmlContent.ListHtmlContent

Get entities from htmlContents

Request

GET /htmlContents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

htmlContents.htmlContent.GetHtmlContent

Get entity from htmlContents by key

Request

GET /htmlContents({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of htmlContent
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.htmlContent	Retrieved entity
default	odata.error	error

items.item

items.item.ListItem

Get entities from items

Request

GET /items[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

items.item.CreateItem

Add new entity to items

Request

POST /items

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.item		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.item	Created entity
default	odata.error	error

items.item.GetItem

Get entity from items by key

Request

GET /items({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved entity
default	odata.error	error

items.item.GetMainPictureSource

Get media content for item from items

Request

GET /items({id})/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of item

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

items.category

items.GetCategory

Get category from items

Request

GET /items({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

items.UpdateCategory

Update the navigation property category in items

Request

PATCH /items({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteCategory

Delete navigation property category for items

Request

DELETE /items({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of item
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.GetCategoryMainPictureSource

Get media content for the navigation property category from items

Request

GET /items({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of item

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

items.content

items.ListContents

Get contents from items

Request

GET /items({id})/contents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateContents

Create new navigation property to contents for items

Request

POST /items({id})/contents

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.content		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.content	Created navigation property.
default	odata.error	error

items.GetContents

Get contents from items

Request

GET /items({id})/contents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of content
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.content	Retrieved navigation property
default	odata.error	error

items.UpdateContents

Update the navigation property contents in items

Request

PATCH /items({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of content
*body	Microsoft.NAV.content		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteContents

Delete navigation property contents for items

Request

DELETE /items({id})/contents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of content
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.defaultTranslation

items.ListDefaultTranslations

Get defaultTranslations from items

Request

GET /items({id})/defaultTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateDefaultTranslations

Create new navigation property to defaultTranslations for items

Request

POST /items({id})/defaultTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.defaultTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.defaultTranslation	Created navigation property.
default	odata.error	error

items.GetDefaultTranslations

Get defaultTranslations from items

Request

GET /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.defaultTranslation	Retrieved navigation property
default	odata.error	error

items.UpdateDefaultTranslations

Update the navigation property defaultTranslations in items

Request

PATCH /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.defaultTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteDefaultTranslations

Delete navigation property defaultTranslations for items

Request

DELETE /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.document

items.ListDocuments

Get documents from items

Request

GET /items({id})/documents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateDocuments

Create new navigation property to documents for items

Request

POST /items({id})/documents

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.document		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.document	Created navigation property.
default	odata.error	error

items.GetDocuments

Get documents from items

Request

GET /items({id})/documents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

items.UpdateDocuments

Update the navigation property documents in items

Request

PATCH /items({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of document
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteDocuments

Delete navigation property documents for items

Request

DELETE /items({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.documentSource

items.ListDocumentsSources

Get documentsSources from items

Request

GET /items({id})/documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateDocumentsSources

Create new navigation property to documentsSources for items

Request

POST /items({id})/documentsSources

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.documentSource		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created navigation property.
default	odata.error	error

items.GetDocumentsSources

Get documentsSources from items

Request

GET /items({id})/documentsSources({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved navigation property
default	odata.error	error

items.UpdateDocumentsSources

Update the navigation property documentsSources in items

Request

PATCH /items({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of documentSource
*body	Microsoft.NAV.documentSource		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteDocumentsSources

Delete navigation property documentsSources for items

Request

DELETE /items({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of documentSource
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.feature

items.ListFeatures

Get features from items

Request

GET /items({id})/features[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateFeatures

Create new navigation property to features for items

Request

POST /items({id})/features

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.feature		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.feature	Created navigation property.
default	odata.error	error

items.GetFeatures

Get features from items

Request

GET /items({id})/features({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of feature
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.feature	Retrieved navigation property
default	odata.error	error

items.UpdateFeatures

Update the navigation property features in items

Request

PATCH /items({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of feature
*body	Microsoft.NAV.feature		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteFeatures

Delete navigation property features for items

Request

DELETE /items({id})/features({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of feature
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.htmlContent

items.ListHtmlContents

Get htmlContents from items

Request

GET /items({id})/htmlContents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateHtmlContents

Create new navigation property to htmlContents for items

Request

POST /items({id})/htmlContents

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.htmlContent		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.htmlContent	Created navigation property.
default	odata.error	error

items.GetHtmlContents

Get htmlContents from items

Request

GET /items({id})/htmlContents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of htmlContent
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.htmlContent	Retrieved navigation property
default	odata.error	error

items.UpdateHtmlContents

Update the navigation property htmlContents in items

Request

PATCH /items({id})/htmlContents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of htmlContent
*body	Microsoft.NAV.htmlContent		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteHtmlContents

Delete navigation property htmlContents for items

Request

DELETE /items({id})/htmlContents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of htmlContent
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.keyword

items.ListKeywords

Get keywords from items

Request

GET /items({id})/keywords[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateKeywords

Create new navigation property to keywords for items

Request

POST /items({id})/keywords

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.keyword		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keyword	Created navigation property.
default	odata.error	error

items.GetKeywords

Get keywords from items

Request

GET /items({id})/keywords({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keyword	Retrieved navigation property
default	odata.error	error

items.UpdateKeywords

Update the navigation property keywords in items

Request

PATCH /items({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of keyword
*body	Microsoft.NAV.keyword		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteKeywords

Delete navigation property keywords for items

Request

DELETE /items({id})/keywords({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of keyword
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.price

items.ListPrices

Get prices from items

Request

GET /items({id})/prices[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreatePrices

Create new navigation property to prices for items

Request

POST /items({id})/prices

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.price		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.price	Created navigation property.
default	odata.error	error

items.GetPrices

Get prices from items

Request

GET /items({id})/prices({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of price
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.price	Retrieved navigation property
default	odata.error	error

items.UpdatePrices

Update the navigation property prices in items

Request

PATCH /items({id})/prices({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of price
*body	Microsoft.NAV.price		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeletePrices

Delete navigation property prices for items

Request

DELETE /items({id})/prices({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of price
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.reference

items.ListReferences

Get references from items

Request

GET /items({id})/references[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateReferences

Create new navigation property to references for items

Request

POST /items({id})/references

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.reference		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.reference	Created navigation property.
default	odata.error	error

items.GetReferences

Get references from items

Request

GET /items({id})/references({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.reference	Retrieved navigation property
default	odata.error	error

items.UpdateReferences

Update the navigation property references in items

Request

PATCH /items({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of reference
*body	Microsoft.NAV.reference		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteReferences

Delete navigation property references for items

Request

DELETE /items({id})/references({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of reference
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.text

items.ListTexts

Get texts from items

Request

GET /items({id})/texts[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateTexts

Create new navigation property to texts for items

Request

POST /items({id})/texts

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.text		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.text	Created navigation property.
default	odata.error	error

items.GetTexts

Get texts from items

Request

GET /items({id})/texts({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved navigation property
default	odata.error	error

items.UpdateTexts

Update the navigation property texts in items

Request

PATCH /items({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of text
*body	Microsoft.NAV.text		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteTexts

Delete navigation property texts for items

Request

DELETE /items({id})/texts({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.GetTextsSource

Get media content for the navigation property texts from items

Request

GET /items({id})/texts({id1})/source

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

items.variant

items.ListVariants

Get variants from items

Request

GET /items({id})/variants[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

items.CreateVariants

Create new navigation property to variants for items

Request

POST /items({id})/variants

Parameters

Name	Type	Default	Notes
*id			key: id of item
*body	Microsoft.NAV.variant		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.variant	Created navigation property.
default	odata.error	error

items.GetVariants

Get variants from items

Request

GET /items({id})/variants({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of variant
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.variant	Retrieved navigation property
default	odata.error	error

items.UpdateVariants

Update the navigation property variants in items

Request

PATCH /items({id})/variants({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of variant
*body	Microsoft.NAV.variant		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

items.DeleteVariants

Delete navigation property variants for items

Request

DELETE /items({id})/variants({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of item
*id1			key: id of variant
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.keyword

keywords.keyword.ListKeyword

Get entities from keywords

Request

GET /keywords[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

keywords.keyword.CreateKeyword

Add new entity to keywords

Request

POST /keywords

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.keyword		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keyword	Created entity
default	odata.error	error

keywords.keyword.GetKeyword

Get entity from keywords by key

Request

GET /keywords({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keyword	Retrieved entity
default	odata.error	error

keywords.category

keywords.GetCategory

Get category from keywords

Request

GET /keywords({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

keywords.UpdateCategory

Update the navigation property category in keywords

Request

PATCH /keywords({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.DeleteCategory

Delete navigation property category for keywords

Request

DELETE /keywords({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.GetCategoryMainPictureSource

Get media content for the navigation property category from keywords

Request

GET /keywords({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of keyword

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

keywords.item

keywords.GetItem

Get item from keywords

Request

GET /keywords({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

keywords.UpdateItem

Update the navigation property item in keywords

Request

PATCH /keywords({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.DeleteItem

Delete navigation property item for keywords

Request

DELETE /keywords({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.GetItemMainPictureSource

Get media content for the navigation property item from keywords

Request

GET /keywords({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of keyword

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

keywords.keywordTranslation

keywords.ListKeywordTranslations

Get keywordTranslations from keywords

Request

GET /keywords({id})/keywordTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

keywords.CreateKeywordTranslations

Create new navigation property to keywordTranslations for keywords

Request

POST /keywords({id})/keywordTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*body	Microsoft.NAV.keywordTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keywordTranslation	Created navigation property.
default	odata.error	error

keywords.GetKeywordTranslations

Get keywordTranslations from keywords

Request

GET /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keywordTranslation	Retrieved navigation property
default	odata.error	error

keywords.UpdateKeywordTranslations

Update the navigation property keywordTranslations in keywords

Request

PATCH /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
*body	Microsoft.NAV.keywordTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywords.DeleteKeywordTranslations

Delete navigation property keywordTranslations for keywords

Request

DELETE /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of keyword
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywordTranslations.keywordTranslation

keywordTranslations.keywordTranslation.ListKeywordTranslation

Get entities from keywordTranslations

Request

GET /keywordTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

keywordTranslations.keywordTranslation.CreateKeywordTranslation

Add new entity to keywordTranslations

Request

POST /keywordTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.keywordTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.keywordTranslation	Created entity
default	odata.error	error

keywordTranslations.keywordTranslation.GetKeywordTranslation

Get entity from keywordTranslations by key

Request

GET /keywordTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keywordTranslation	Retrieved entity
default	odata.error	error

keywordTranslations.keyword

keywordTranslations.GetKeyword

Get keyword from keywordTranslations

Request

GET /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.keyword	Retrieved navigation property
default	odata.error	error

keywordTranslations.UpdateKeyword

Update the navigation property keyword in keywordTranslations

Request

PATCH /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
*body	Microsoft.NAV.keyword		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

keywordTranslations.DeleteKeyword

Delete navigation property keyword for keywordTranslations

Request

DELETE /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of keywordTranslation
*lang			key: lang of keywordTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

prices.price

prices.price.ListPrice

Get entities from prices

Request

GET /prices[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

prices.price.GetPrice

Get entity from prices by key

Request

GET /prices({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of price
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.price	Retrieved entity
default	odata.error	error

prices.item

prices.GetItem

Get item from prices

Request

GET /prices({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of price
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

prices.UpdateItem

Update the navigation property item in prices

Request

PATCH /prices({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of price
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

prices.DeleteItem

Delete navigation property item for prices

Request

DELETE /prices({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of price
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

prices.GetItemMainPictureSource

Get media content for the navigation property item from prices

Request

GET /prices({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of price

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

references.reference

references.reference.ListReference

Get entities from references

Request

GET /references[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

references.reference.CreateReference

Add new entity to references

Request

POST /references

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.reference		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.reference	Created entity
default	odata.error	error

references.reference.GetReference

Get entity from references by key

Request

GET /references({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.reference	Retrieved entity
default	odata.error	error

references.category

references.GetCategory

Get category from references

Request

GET /references({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

references.UpdateCategory

Update the navigation property category in references

Request

PATCH /references({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.DeleteCategory

Delete navigation property category for references

Request

DELETE /references({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of reference
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.GetCategoryMainPictureSource

Get media content for the navigation property category from references

Request

GET /references({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of reference

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

references.defaultTranslation

references.ListDefaultTranslations

Get defaultTranslations from references

Request

GET /references({id})/defaultTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of reference
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

references.CreateDefaultTranslations

Create new navigation property to defaultTranslations for references

Request

POST /references({id})/defaultTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*body	Microsoft.NAV.defaultTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.defaultTranslation	Created navigation property.
default	odata.error	error

references.GetDefaultTranslations

Get defaultTranslations from references

Request

GET /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.defaultTranslation	Retrieved navigation property
default	odata.error	error

references.UpdateDefaultTranslations

Update the navigation property defaultTranslations in references

Request

PATCH /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
*body	Microsoft.NAV.defaultTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.DeleteDefaultTranslations

Delete navigation property defaultTranslations for references

Request

DELETE /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*lineGuid			key: lineGuid of defaultTranslation
*lang			key: lang of defaultTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.item

references.GetItem

Get item from references

Request

GET /references({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of reference
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

references.UpdateItem

Update the navigation property item in references

Request

PATCH /references({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of reference
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.DeleteItem

Delete navigation property item for references

Request

DELETE /references({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of reference
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

references.GetItemMainPictureSource

Get media content for the navigation property item from references

Request

GET /references({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of reference

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

subscriptions.subscriptions

subscriptions.subscriptions.ListSubscriptions

Get entities from subscriptions

Request

GET /subscriptions[?$top&$skip&$search&$filter&$count&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

subscriptions.subscriptions.CreateSubscriptions

Add new entity to subscriptions

Request

POST /subscriptions

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.subscriptions		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.subscriptions	Created entity
default	odata.error	error

subscriptions.subscriptions.GetSubscriptions

Get entity from subscriptions by key

Request

GET /subscriptions({subscriptionId})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*subscriptionId			key: subscriptionId of subscriptions
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.subscriptions	Retrieved entity
default	odata.error	error

subscriptions.subscriptions.UpdateSubscriptions

Update entity in subscriptions

Request

PATCH /subscriptions({subscriptionId})

Parameters

Name	Type	Default	Notes
*subscriptionId			key: subscriptionId of subscriptions
*body	Microsoft.NAV.subscriptions		New property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

subscriptions.subscriptions.DeleteSubscriptions

Delete entity from subscriptions

Request

DELETE /subscriptions({subscriptionId})

Parameters

Name	Type	Default	Notes
*subscriptionId			key: subscriptionId of subscriptions
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.text

texts.text.ListText

Get entities from texts

Request

GET /texts[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

texts.text.CreateText

Add new entity to texts

Request

POST /texts

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.text		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.text	Created entity
default	odata.error	error

texts.text.GetText

Get entity from texts by key

Request

GET /texts({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved entity
default	odata.error	error

texts.text.GetSource

Get media content for text from texts

Request

GET /texts({id})/source

Parameters

Name	Type	Default	Notes
*id			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

texts.category

texts.GetCategory

Get category from texts

Request

GET /texts({id})/category[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.category	Retrieved navigation property
default	odata.error	error

texts.UpdateCategory

Update the navigation property category in texts

Request

PATCH /texts({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of text
*body	Microsoft.NAV.category		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.DeleteCategory

Delete navigation property category for texts

Request

DELETE /texts({id})/category

Parameters

Name	Type	Default	Notes
*id			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.GetCategoryMainPictureSource

Get media content for the navigation property category from texts

Request

GET /texts({id})/category/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

texts.document

texts.GetDocument

Get document from texts

Request

GET /texts({id})/document[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

texts.UpdateDocument

Update the navigation property document in texts

Request

PATCH /texts({id})/document

Parameters

Name	Type	Default	Notes
*id			key: id of text
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.DeleteDocument

Delete navigation property document for texts

Request

DELETE /texts({id})/document

Parameters

Name	Type	Default	Notes
*id			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.item

texts.GetItem

Get item from texts

Request

GET /texts({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

texts.UpdateItem

Update the navigation property item in texts

Request

PATCH /texts({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of text
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.DeleteItem

Delete navigation property item for texts

Request

DELETE /texts({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of text
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.GetItemMainPictureSource

Get media content for the navigation property item from texts

Request

GET /texts({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of text

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

texts.textTranslation

texts.ListTextTranslations

Get textTranslations from texts

Request

GET /texts({id})/textTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

texts.CreateTextTranslations

Create new navigation property to textTranslations for texts

Request

POST /texts({id})/textTranslations

Parameters

Name	Type	Default	Notes
*id			key: id of text
*body	Microsoft.NAV.textTranslation		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.textTranslation	Created navigation property.
default	odata.error	error

texts.GetTextTranslations

Get textTranslations from texts

Request

GET /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of text
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.textTranslation	Retrieved navigation property
default	odata.error	error

texts.UpdateTextTranslations

Update the navigation property textTranslations in texts

Request

PATCH /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of text
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
*body	Microsoft.NAV.textTranslation		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

texts.DeleteTextTranslations

Delete navigation property textTranslations for texts

Request

DELETE /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})

Parameters

Name	Type	Default	Notes
*id			key: id of text
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

textTranslations.textTranslation

textTranslations.textTranslation.ListTextTranslation

Get entities from textTranslations

Request

GET /textTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

textTranslations.textTranslation.CreateTextTranslation

Add new entity to textTranslations

Request

POST /textTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.textTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.textTranslation	Created entity
default	odata.error	error

textTranslations.textTranslation.GetTextTranslation

Get entity from textTranslations by key

Request

GET /textTranslations(lineGuid={lineGuid},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.textTranslation	Retrieved entity
default	odata.error	error

textTranslations.text

textTranslations.GetText

Get text from textTranslations

Request

GET /textTranslations(lineGuid={lineGuid},lang={lang})/text[?$select&$expand]

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.text	Retrieved navigation property
default	odata.error	error

textTranslations.UpdateText

Update the navigation property text in textTranslations

Request

PATCH /textTranslations(lineGuid={lineGuid},lang={lang})/text

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
*body	Microsoft.NAV.text		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

textTranslations.DeleteText

Delete navigation property text for textTranslations

Request

DELETE /textTranslations(lineGuid={lineGuid},lang={lang})/text

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

textTranslations.GetTextSource

Get media content for the navigation property text from textTranslations

Request

GET /textTranslations(lineGuid={lineGuid},lang={lang})/text/source

Parameters

Name	Type	Default	Notes
*lineGuid			key: lineGuid of textTranslation
*lang			key: lang of textTranslation

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

valueTranslations.valueTranslation

valueTranslations.valueTranslation.ListValueTranslation

Get entities from valueTranslations

Request

GET /valueTranslations[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

valueTranslations.valueTranslation.CreateValueTranslation

Add new entity to valueTranslations

Request

POST /valueTranslations

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.valueTranslation		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.valueTranslation	Created entity
default	odata.error	error

valueTranslations.valueTranslation.GetValueTranslation

Get entity from valueTranslations by key

Request

GET /valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*type			key: type of valueTranslation
*code			key: code of valueTranslation
*variantCode			key: variantCode of valueTranslation
*lineNo			key: lineNo of valueTranslation
*no			key: no of valueTranslation
*lang			key: lang of valueTranslation
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.valueTranslation	Retrieved entity
default	odata.error	error

variants.variant

variants.variant.ListVariant

Get entities from variants

Request

GET /variants[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved entities
default	odata.error	error

variants.variant.CreateVariant

Add new entity to variants

Request

POST /variants

Parameters

Name	Type	Default	Notes
*body	Microsoft.NAV.variant		New entity

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.variant	Created entity
default	odata.error	error

variants.variant.GetVariant

Get entity from variants by key

Request

GET /variants({id})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.variant	Retrieved entity
default	odata.error	error

variants.document

variants.ListDocuments

Get documents from variants

Request

GET /variants({id})/documents[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

variants.CreateDocuments

Create new navigation property to documents for variants

Request

POST /variants({id})/documents

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*body	Microsoft.NAV.document		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.document	Created navigation property.
default	odata.error	error

variants.GetDocuments

Get documents from variants

Request

GET /variants({id})/documents({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of document
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.document	Retrieved navigation property
default	odata.error	error

variants.UpdateDocuments

Update the navigation property documents in variants

Request

PATCH /variants({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of document
*body	Microsoft.NAV.document		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.DeleteDocuments

Delete navigation property documents for variants

Request

DELETE /variants({id})/documents({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of document
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.documentSource

variants.ListDocumentsSources

Get documentsSources from variants

Request

GET /variants({id})/documentsSources[?$top&$skip&$search&$filter&$count&$orderby&$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
$top			Show only the first n items
$skip			Skip the first n items
$search			Search items by search phrases
$filter			Filter items by property values
$count			Include count of items
$orderby			Order items by property values
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	object	Retrieved navigation property
default	odata.error	error

variants.CreateDocumentsSources

Create new navigation property to documentsSources for variants

Request

POST /variants({id})/documentsSources

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*body	Microsoft.NAV.documentSource		New navigation property

Responses

Status Code	Type	Description	Samples
201	Microsoft.NAV.documentSource	Created navigation property.
default	odata.error	error

variants.GetDocumentsSources

Get documentsSources from variants

Request

GET /variants({id})/documentsSources({id1})[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of documentSource
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.documentSource	Retrieved navigation property
default	odata.error	error

variants.UpdateDocumentsSources

Update the navigation property documentsSources in variants

Request

PATCH /variants({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of documentSource
*body	Microsoft.NAV.documentSource		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.DeleteDocumentsSources

Delete navigation property documentsSources for variants

Request

DELETE /variants({id})/documentsSources({id1})

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*id1			key: id of documentSource
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.item

variants.GetItem

Get item from variants

Request

GET /variants({id})/item[?$select&$expand]

Parameters

Name	Type	Default	Notes
*id			key: id of variant
$select			Select properties to be returned
$expand			Expand related entities

Responses

Status Code	Type	Description	Samples
200	Microsoft.NAV.item	Retrieved navigation property
default	odata.error	error

variants.UpdateItem

Update the navigation property item in variants

Request

PATCH /variants({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of variant
*body	Microsoft.NAV.item		New navigation property values

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.DeleteItem

Delete navigation property item for variants

Request

DELETE /variants({id})/item

Parameters

Name	Type	Default	Notes
*id			key: id of variant
If-Match			ETag

Responses

Status Code	Type	Description	Samples
204		Success
default	odata.error	error

variants.GetItemMainPictureSource

Get media content for the navigation property item from variants

Request

GET /variants({id})/item/mainPictureSource

Parameters

Name	Type	Default	Notes
*id			key: id of variant

Responses

Status Code	Type	Description	Samples
200	string	Retrieved media content
default	odata.error	error

Definitions

odata.error

Name	Type	Notes
error	odata.error.main[]

odata.error.main

Name	Type	Notes
code	string
message	string
target	string
details	odata.error.detail[]
innererror	object	The structure of this object is service-specific

odata.error.detail

Name	Type	Notes
code	string
message	string
target	string

Microsoft.NAV.apicategoryroutes

Name	Type	Notes
route	string
publisher	string
group	string
version	string

Microsoft.NAV.category

Name	Type	Notes
id	string (uuid)
publicationCode	string
number	string
description	string
description2	string
type	string
mainPictureId	string
mainPictureSource	string (base64url)
element	string
parentId	string (uuid)
categoryId	string (uuid)
sisterLineId	string (uuid)
templateCode	string
state	Microsoft.NAV.pimxPublicationLineState
features	Microsoft.NAV.feature[]
texts	Microsoft.NAV.text[]
documents	Microsoft.NAV.document[]
documentsSources	Microsoft.NAV.documentSource[]
items	Microsoft.NAV.item[]
references	Microsoft.NAV.reference[]
keywords	Microsoft.NAV.keyword[]
defaultTranslations	Microsoft.NAV.defaultTranslation[]
contents	Microsoft.NAV.content[]

Microsoft.NAV.pimxPublicationLineState

Enum Values

Draft
Published
Deleted

Microsoft.NAV.feature

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
group	string
number	string
lineType	string
description	string
valueId	string
value	string
textValue	string
fromValue	number (decimal)
toValue	number (decimal)
unitCode	string
unit	string
unitShorthand	string
classification	string
type	string
order	integer (int32)
polyvalent	boolean
featureType	Microsoft.NAV.pimxFeatureType
parentItemNo	string
dataId	string (uuid)
valueSearchDescription	string
importance	Microsoft.NAV.pimxImportance
relevance	Microsoft.NAV.pimxRelevance
valueSetId	integer (int64)
sorting	integer (int32)
element	string
state	Microsoft.NAV.pimxPublicationLineState
usageTypeCode	string
category
featuresValues	Microsoft.NAV.featureValue[]
featureValueSets	Microsoft.NAV.featureValueSet[]
featureTranslations	Microsoft.NAV.featureTranslation[]
item	Microsoft.NAV.item[]

Microsoft.NAV.pimxFeatureType

Enum Values

Base
Specification
Filter
Variant

Microsoft.NAV.pimxImportance

Enum Values

Optional
Recommended
Required
Non_x002D_Editable

Microsoft.NAV.pimxRelevance

Enum Values

Normal
Highlighted
Important

Microsoft.NAV.featureValue

Name	Type	Notes
id	string (uuid)
entityType	string
entityNo	string
featureNo	string
number	string
value	string
valueTranslations	Microsoft.NAV.valueTranslation[]

Microsoft.NAV.valueTranslation

Name	Type	Notes
type	string
code	string
variantCode	string
lineNo	integer (int32)
no	integer (int32)
lang	string
description	string

Microsoft.NAV.featureValueSet

Name	Type	Notes
id	string (uuid)
featureId	string
valueId	string
value	string
valueTranslations	Microsoft.NAV.valueTranslation[]

Microsoft.NAV.featureTranslation

Name	Type	Notes
lineGuid	string (uuid)
lang	string
description	string
value	string
unitShorthand	string
unitDescription	string
feature

Microsoft.NAV.item

Name	Type	Notes
id	string (uuid)
sisterLineId	string (uuid)
itemId	string (uuid)
type	string
publicationCode	string
number	string
description	string
description2	string
mainPictureId	string
mainPictureSource	string (base64url)
element	string
categoryId	string (uuid)
templateCode	string
state
category
features	array
texts	Microsoft.NAV.text[]
documents	Microsoft.NAV.document[]
documentsSources	Microsoft.NAV.documentSource[]
references	Microsoft.NAV.reference[]
keywords	Microsoft.NAV.keyword[]
defaultTranslations	Microsoft.NAV.defaultTranslation[]
contents	Microsoft.NAV.content[]
htmlContents	Microsoft.NAV.htmlContent[]
variants	Microsoft.NAV.variant[]
prices	Microsoft.NAV.price[]

Microsoft.NAV.text

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
group	string
class	string
source	string (base64url)
text	string
element	string
description	string
description2	string
dataId	string (uuid)
state
category
textTranslations	Microsoft.NAV.textTranslation[]
document
item

Microsoft.NAV.textTranslation

Name	Type	Notes
lineGuid	string (uuid)
lang	string
description	string
description2	string
html	string
text

Microsoft.NAV.document

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
group	string
type	string
number	string
description	string
description2	string
link	string
sourceFileName	string
mimeType	string
templateCode	string
order	integer (int32)
documentUsage	string
dataId	string (uuid)
repositoryType
externalContainerId	string
externalId	string
state
sorting	integer (int32)
category
documentsSources	Microsoft.NAV.documentSource[]
documentTranslations	Microsoft.NAV.documentTranslation[]
texts	array
item
variant

Microsoft.NAV.documentSource

Name	Type	Notes
id	string (uuid)
code	string
source	string

Microsoft.NAV.documentTranslation

Name	Type	Notes
lineGuid	string (uuid)
lang	string
description	string
description2	string
document

Microsoft.NAV.reference

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
group	string
referenceType	string
lineType	string
number	string
description	string
description2	string
order	integer (int32)
dataId	string (uuid)
templateCode	string
state
category
item
defaultTranslations	Microsoft.NAV.defaultTranslation[]

Microsoft.NAV.defaultTranslation

Name	Type	Notes
lineGuid	string (uuid)
lang	string
description	string
description2	string
category
item
reference

Microsoft.NAV.keyword

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
group	string
number	string
description	string
order	integer (int32)
dataId	string (uuid)
templateCode	string
state
category
item
keywordTranslations	Microsoft.NAV.keywordTranslation[]

Microsoft.NAV.keywordTranslation

Name	Type	Notes
lineGuid	string (uuid)
lang	string
description	string
keyword

Microsoft.NAV.content

Name	Type	Notes
id	string (uuid)
publicationCode	string
lineId	string (uuid)
lineType	string
lineEntityUrl	string
parentLineId	string (uuid)
parentLineType	string
parentEntityUrl	string
templateCode	string
level	integer (int32)
lineNo	integer (int32)
dataId	string (uuid)
state
category
item

Microsoft.NAV.htmlContent

Name	Type	Notes
id	string (uuid)
publicationCode	string
data	string
status	string
state

Microsoft.NAV.variant

Name	Type	Notes
id	string (uuid)
parentEntityId	string (uuid)
dataId	string (uuid)
publicationCode	string
group	string
number	string
description	string
description2	string
mainPictureId	string
state
item
documents	array
documentsSources	Microsoft.NAV.documentSource[]

Microsoft.NAV.price

Name	Type	Notes
id	string (uuid)
publicationLineId	string (uuid)
code	string
unitOfMeasure	string
minimumQuantity	number (decimal)
currencyCode	string
itemNo	string
price	number (decimal)
vat	number (decimal)
priceInclVAT	number (decimal)
startingDate	string (date)
endingDate	string (date)
updatedOn	string (date-time)
updatedBy	string
item

Microsoft.NAV.changedLine

Name	Type	Notes
id	string (uuid)
lineId	string (uuid)
lineType	string
publicationCode	string
lineEntityUrl	string
parentLineId	string (uuid)
parentLineType	string
parentLineUrl	string
dateModified	string (date-time)
state	Microsoft.NAV.pimxPublicationLineState

Microsoft.NAV.company

Name	Type	Notes
id	string (uuid)
systemVersion	string
timestamp	integer (int64)
name	string
displayName	string
businessProfileId	string
systemCreatedAt	string (date-time)
systemCreatedBy	string (uuid)
systemModifiedAt	string (date-time)
systemModifiedBy	string (uuid)
changedLines	Microsoft.NAV.changedLine[]
deletedLines	Microsoft.NAV.deletedLine[]
htmlContents	Microsoft.NAV.htmlContent[]
featureValueSets	Microsoft.NAV.featureValueSet[]
valueTranslations	Microsoft.NAV.valueTranslation[]
prices	Microsoft.NAV.price[]
categories	Microsoft.NAV.category[]
features	Microsoft.NAV.feature[]
featuresValues	Microsoft.NAV.featureValue[]
featureTranslations	Microsoft.NAV.featureTranslation[]
texts	Microsoft.NAV.text[]
textTranslations	Microsoft.NAV.textTranslation[]
documents	Microsoft.NAV.document[]
documentsSources	Microsoft.NAV.documentSource[]
documentTranslations	Microsoft.NAV.documentTranslation[]
items	Microsoft.NAV.item[]
references	Microsoft.NAV.reference[]
defaultTranslations	Microsoft.NAV.defaultTranslation[]
keywords	Microsoft.NAV.keyword[]
keywordTranslations	Microsoft.NAV.keywordTranslation[]
contents	Microsoft.NAV.content[]
variants	Microsoft.NAV.variant[]

Microsoft.NAV.deletedLine

Name	Type	Notes
logId	string (uuid)
id	string (uuid)
lineId	string (uuid)
lineType	string
publicationCode	string
lineEntityUrl	string
parentLineId	string (uuid)
parentLineType	string
parentLineUrl	string
dateModified	string (date-time)

Microsoft.NAV.entityMetadata

Name	Type	Notes
entityName	string
entitySetName	string
entityCaptions	Microsoft.NAV.entityMetadataLabel[]
entitySetCaptions	Microsoft.NAV.entityMetadataLabel[]
properties	Microsoft.NAV.entityMetadataField[]
actions	Microsoft.NAV.entityMetadataAction[]
enumMembers	Microsoft.NAV.entityMetadataEnumMember[]

Microsoft.NAV.entityMetadataLabel

Name	Type	Notes
languageCode	integer (int32)
caption	string

Microsoft.NAV.entityMetadataField

Name	Type	Notes
name	string
captions	array

Microsoft.NAV.entityMetadataAction

Name	Type	Notes
name	string
captions	array

Microsoft.NAV.entityMetadataEnumMember

Name	Type	Notes
name	string
value	integer (int32)
captions	array

Microsoft.NAV.externalbusinesseventdefinitions

Name	Type	Notes
appId	string (uuid)
name	string
eventVersion	string
isObsolete	boolean
obsoleteReason	string
obsoleteTag	string
payload	string
displayName	string
description	string
category	string
appName	string
appPublisher	string
appVersion	string

Microsoft.NAV.externaleventsubscriptions

Name	Type	Notes
id	string (uuid)
companyId	string (uuid)
timestamp	integer (int64)
appId	string (uuid)
eventName	string
companyName	string
userId	string (uuid)
notificationUrl	string
lastModifiedDateTime	string (date-time)
clientState	string
subscriptionType	string
eventVersion	string
subscriptionState	string
systemCreatedAt	string (date-time)
systemCreatedBy	string (uuid)
systemModifiedAt	string (date-time)
systemModifiedBy	string (uuid)

Microsoft.NAV.subscriptions

Name	Type	Notes
subscriptionId	string
notificationUrl	string
resource	string
timestamp	integer (int64)
userId	string (uuid)
lastModifiedDateTime	string (date-time)
clientState	string
expirationDateTime	string (date-time)
systemCreatedAt	string (date-time)
systemCreatedBy	string (uuid)
systemModifiedAt	string (date-time)
systemModifiedBy	string (uuid)