Pimics Publication API OData specification

Pimics Publication API OData specification
More information: https://docs.pimics.com
Version: 12.0.0
BasePath:/v2.0/Production/api/pimics/publication/v2.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

  1. OAuth AuthorizationUrl:TokenUrl:https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token

Methods

[ Jump to Models ]

Table of Contents

ApicategoryroutesApicategoryroutes

CategoriesCategory

CategoriesContent

CategoriesDefaultTranslation

CategoriesDocument

CategoriesDocumentSource

CategoriesFeature

CategoriesItem

CategoriesKeyword

CategoriesReference

CategoriesText

ChangedLinesChangedLine

CompaniesCategory

CompaniesChangedLine

CompaniesCompany

CompaniesContent

CompaniesDefaultTranslation

CompaniesDeletedLine

CompaniesDocument

CompaniesDocumentSource

CompaniesDocumentTranslation

CompaniesFeature

CompaniesFeatureTranslation

CompaniesFeatureValue

CompaniesFeatureValueSet

CompaniesHtmlContent

CompaniesItem

CompaniesKeyword

CompaniesKeywordTranslation

CompaniesPrice

CompaniesReference

CompaniesText

CompaniesTextTranslation

CompaniesValueTranslation

CompaniesVariant

ContentsCategory

ContentsContent

ContentsItem

DefaultTranslationsCategory

DefaultTranslationsDefaultTranslation

DefaultTranslationsItem

DefaultTranslationsReference

DeletedLinesDeletedLine

DocumentTranslationsDocument

DocumentTranslationsDocumentTranslation

DocumentsCategory

DocumentsDocument

DocumentsDocumentSource

DocumentsDocumentTranslation

DocumentsItem

DocumentsSourcesDocumentSource

DocumentsText

DocumentsVariant

EntityDefinitionsEntityMetadata

ExternalbusinesseventdefinitionsExternalbusinesseventdefinitions

ExternaleventsubscriptionsExternaleventsubscriptions

FeatureTranslationsFeature

FeatureTranslationsFeatureTranslation

FeatureValueSetsFeatureValueSet

FeatureValueSetsValueTranslation

FeaturesCategory

FeaturesFeature

FeaturesFeatureTranslation

FeaturesFeatureValue

FeaturesFeatureValueSet

FeaturesItem

FeaturesValuesFeatureValue

FeaturesValuesValueTranslation

HtmlContentsHtmlContent

ItemsCategory

ItemsContent

ItemsDefaultTranslation

ItemsDocument

ItemsDocumentSource

ItemsFeature

ItemsHtmlContent

ItemsItem

ItemsKeyword

ItemsPrice

ItemsReference

ItemsText

ItemsVariant

KeywordTranslationsKeyword

KeywordTranslationsKeywordTranslation

KeywordsCategory

KeywordsItem

KeywordsKeyword

KeywordsKeywordTranslation

PricesItem

PricesPrice

ReferencesCategory

ReferencesDefaultTranslation

ReferencesItem

ReferencesReference

SubscriptionsSubscriptions

TextTranslationsText

TextTranslationsTextTranslation

TextsCategory

TextsDocument

TextsItem

TextsText

TextsTextTranslation

ValueTranslationsValueTranslation

VariantsDocument

VariantsDocumentSource

VariantsItem

VariantsVariant

ApicategoryroutesApicategoryroutes

Up 
get /apicategoryroutes({route})
Get entity from apicategoryroutes by key (apicategoryroutes.apicategoryroutes.GetApicategoryroutes)

Path parameters

route (required)
Path Parameter — key: route of apicategoryroutes

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.apicategoryroutes

Example data

Content-Type: application/json
{
  "route" : "string (identifier)",
  "publisher" : "string",
  "group" : "string",
  "version" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.apicategoryroutes

default

error odata.error
Up 
get /apicategoryroutes
Get entities from apicategoryroutes (apicategoryroutes.apicategoryroutes.ListApicategoryroutes)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of apicategoryroutes

Example data

Content-Type: application/json
{
  "value" : [ {
    "route" : "string (identifier)",
    "publisher" : "string",
    "group" : "string",
    "version" : "string"
  }, {
    "route" : "string (identifier)",
    "publisher" : "string",
    "group" : "string",
    "version" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of apicategoryroutes

default

error odata.error

CategoriesCategory

Up 
get /categories({id})
Get entity from categories by key (categories.category.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.category

default

error odata.error
Up 
get /categories({id})/mainPictureSource
Get media content for category from categories (categories.category.GetMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /categories
Get entities from categories (categories.category.ListCategory)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of category

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "type" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "parentId" : "string",
    "categoryId" : "string",
    "sisterLineId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ]
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "type" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "parentId" : "string",
    "categoryId" : "string",
    "sisterLineId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of category

default

error odata.error

CategoriesContent

Up 
post /categories({id})/contents
Create new navigation property to contents for categories (categories.CreateContents)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.content

default

error odata.error
Up 
delete /categories({id})/contents({id1})
Delete navigation property contents for categories (categories.DeleteContents)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/contents({id1})
Get contents from categories (categories.GetContents)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.content

default

error odata.error
Up 
get /categories({id})/contents
Get contents from categories (categories.ListContents)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of content

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of content

default

error odata.error
Up 
patch /categories({id})/contents({id1})
Update the navigation property contents in categories (categories.UpdateContents)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesDefaultTranslation

Up 
post /categories({id})/defaultTranslations
Create new navigation property to defaultTranslations for categories (categories.CreateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
delete /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property defaultTranslations for categories (categories.DeleteDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Get defaultTranslations from categories (categories.GetDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /categories({id})/defaultTranslations
Get defaultTranslations from categories (categories.ListDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of defaultTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of defaultTranslation

default

error odata.error
Up 
patch /categories({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property defaultTranslations in categories (categories.UpdateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesDocument

Up 
post /categories({id})/documents
Create new navigation property to documents for categories (categories.CreateDocuments)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.document

default

error odata.error
Up 
delete /categories({id})/documents({id1})
Delete navigation property documents for categories (categories.DeleteDocuments)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/documents({id1})
Get documents from categories (categories.GetDocuments)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
get /categories({id})/documents
Get documents from categories (categories.ListDocuments)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of document

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of document

default

error odata.error
Up 
patch /categories({id})/documents({id1})
Update the navigation property documents in categories (categories.UpdateDocuments)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesDocumentSource

Up 
post /categories({id})/documentsSources
Create new navigation property to documentsSources for categories (categories.CreateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentSource

default

error odata.error
Up 
delete /categories({id})/documentsSources({id1})
Delete navigation property documentsSources for categories (categories.DeleteDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/documentsSources({id1})
Get documentsSources from categories (categories.GetDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentSource

default

error odata.error
Up 
get /categories({id})/documentsSources
Get documentsSources from categories (categories.ListDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentSource

default

error odata.error
Up 
patch /categories({id})/documentsSources({id1})
Update the navigation property documentsSources in categories (categories.UpdateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesFeature

Up 
post /categories({id})/features
Create new navigation property to features for categories (categories.CreateFeatures)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.feature

default

error odata.error
Up 
delete /categories({id})/features({id1})
Delete navigation property features for categories (categories.DeleteFeatures)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/features({id1})
Get features from categories (categories.GetFeatures)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.feature

default

error odata.error
Up 
get /categories({id})/features
Get features from categories (categories.ListFeatures)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of feature

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of feature

default

error odata.error
Up 
patch /categories({id})/features({id1})
Update the navigation property features in categories (categories.UpdateFeatures)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesItem

Up 
post /categories({id})/items
Create new navigation property to items for categories (categories.CreateItems)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.item

default

error odata.error
Up 
delete /categories({id})/items({id1})
Delete navigation property items for categories (categories.DeleteItems)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/items({id1})
Get items from categories (categories.GetItems)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /categories({id})/items({id1})/mainPictureSource
Get media content for the navigation property items from categories (categories.GetItemsMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /categories({id})/items
Get items from categories (categories.ListItems)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of item

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  }, {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of item

default

error odata.error
Up 
patch /categories({id})/items({id1})
Update the navigation property items in categories (categories.UpdateItems)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesKeyword

Up 
post /categories({id})/keywords
Create new navigation property to keywords for categories (categories.CreateKeywords)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.keyword

default

error odata.error
Up 
delete /categories({id})/keywords({id1})
Delete navigation property keywords for categories (categories.DeleteKeywords)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/keywords({id1})
Get keywords from categories (categories.GetKeywords)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keyword

default

error odata.error
Up 
get /categories({id})/keywords
Get keywords from categories (categories.ListKeywords)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keyword

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of keyword

default

error odata.error
Up 
patch /categories({id})/keywords({id1})
Update the navigation property keywords in categories (categories.UpdateKeywords)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesReference

Up 
post /categories({id})/references
Create new navigation property to references for categories (categories.CreateReferences)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.reference

default

error odata.error
Up 
delete /categories({id})/references({id1})
Delete navigation property references for categories (categories.DeleteReferences)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/references({id1})
Get references from categories (categories.GetReferences)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.reference

default

error odata.error
Up 
get /categories({id})/references
Get references from categories (categories.ListReferences)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of reference

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of reference

default

error odata.error
Up 
patch /categories({id})/references({id1})
Update the navigation property references in categories (categories.UpdateReferences)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CategoriesText

Up 
post /categories({id})/texts
Create new navigation property to texts for categories (categories.CreateTexts)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.text

default

error odata.error
Up 
delete /categories({id})/texts({id1})
Delete navigation property texts for categories (categories.DeleteTexts)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /categories({id})/texts({id1})
Get texts from categories (categories.GetTexts)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.text

default

error odata.error
Up 
get /categories({id})/texts({id1})/source
Get media content for the navigation property texts from categories (categories.GetTextsSource)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /categories({id})/texts
Get texts from categories (categories.ListTexts)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of text

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of text

default

error odata.error
Up 
patch /categories({id})/texts({id1})
Update the navigation property texts in categories (categories.UpdateTexts)

Path parameters

id (required)
Path Parameter — key: id of category format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ChangedLinesChangedLine

Up 
post /changedLines
Add new entity to changedLines (changedLines.changedLine.CreateChangedLine)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.changedLine (required)
Body Parameter — New entity

Return type

Microsoft.NAV.changedLine

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.changedLine

default

error odata.error
Up 
get /changedLines({id})
Get entity from changedLines by key (changedLines.changedLine.GetChangedLine)

Path parameters

id (required)
Path Parameter — key: id of changedLine format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.changedLine

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.changedLine

default

error odata.error
Up 
get /changedLines
Get entities from changedLines (changedLines.changedLine.ListChangedLine)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of changedLine

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  }, {
    "id" : "string (identifier)",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of changedLine

default

error odata.error

CompaniesCategory

Up 
post /companies({id})/categories
Create new navigation property to categories for companies (companies.CreateCategories)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.category

default

error odata.error
Up 
delete /companies({id})/categories({id1})
Delete navigation property categories for companies (companies.DeleteCategories)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of category format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/categories({id1})
Get categories from companies (companies.GetCategories)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of category format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /companies({id})/categories({id1})/mainPictureSource
Get media content for the navigation property categories from companies (companies.GetCategoriesMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of category format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /companies({id})/categories
Get categories from companies (companies.ListCategories)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of category

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "type" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "parentId" : "string",
    "categoryId" : "string",
    "sisterLineId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ]
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "type" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "parentId" : "string",
    "categoryId" : "string",
    "sisterLineId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of category

default

error odata.error
Up 
patch /companies({id})/categories({id1})
Update the navigation property categories in companies (companies.UpdateCategories)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of category format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesChangedLine

Up 
post /companies({id})/changedLines
Create new navigation property to changedLines for companies (companies.CreateChangedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.changedLine (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.changedLine

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.changedLine

default

error odata.error
Up 
delete /companies({id})/changedLines({id1})
Delete navigation property changedLines for companies (companies.DeleteChangedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of changedLine format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/changedLines({id1})
Get changedLines from companies (companies.GetChangedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of changedLine format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.changedLine

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.changedLine

default

error odata.error
Up 
get /companies({id})/changedLines
Get changedLines from companies (companies.ListChangedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of changedLine

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  }, {
    "id" : "string (identifier)",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of changedLine

default

error odata.error
Up 
patch /companies({id})/changedLines({id1})
Update the navigation property changedLines in companies (companies.UpdateChangedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of changedLine format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.changedLine (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesCompany

Up 
get /companies({id})
Get entity from companies by key (companies.company.GetCompany)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.company

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "systemVersion" : "string",
  "timestamp" : "integer",
  "name" : "string",
  "displayName" : "string",
  "businessProfileId" : "string",
  "systemCreatedAt" : "string (timestamp)",
  "systemCreatedBy" : "string",
  "systemModifiedAt" : "string (timestamp)",
  "systemModifiedBy" : "string",
  "changedLines" : [ {
    "@odata.type" : "Microsoft.NAV.changedLine"
  } ],
  "deletedLines" : [ {
    "@odata.type" : "Microsoft.NAV.deletedLine"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ],
  "categories" : [ {
    "@odata.type" : "Microsoft.NAV.category"
  } ],
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.company

default

error odata.error
Up 
get /companies
Get entities from companies (companies.company.ListCompany)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of company

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "systemVersion" : "string",
    "timestamp" : "integer",
    "name" : "string",
    "displayName" : "string",
    "businessProfileId" : "string",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string",
    "changedLines" : [ {
      "@odata.type" : "Microsoft.NAV.changedLine"
    } ],
    "deletedLines" : [ {
      "@odata.type" : "Microsoft.NAV.deletedLine"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ],
    "categories" : [ {
      "@odata.type" : "Microsoft.NAV.category"
    } ],
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ]
  }, {
    "id" : "string (identifier)",
    "systemVersion" : "string",
    "timestamp" : "integer",
    "name" : "string",
    "displayName" : "string",
    "businessProfileId" : "string",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string",
    "changedLines" : [ {
      "@odata.type" : "Microsoft.NAV.changedLine"
    } ],
    "deletedLines" : [ {
      "@odata.type" : "Microsoft.NAV.deletedLine"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ],
    "categories" : [ {
      "@odata.type" : "Microsoft.NAV.category"
    } ],
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "items" : [ {
      "@odata.type" : "Microsoft.NAV.item"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of company

default

error odata.error

CompaniesContent

Up 
post /companies({id})/contents
Create new navigation property to contents for companies (companies.CreateContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.content

default

error odata.error
Up 
delete /companies({id})/contents({id1})
Delete navigation property contents for companies (companies.DeleteContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/contents({id1})
Get contents from companies (companies.GetContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.content

default

error odata.error
Up 
get /companies({id})/contents
Get contents from companies (companies.ListContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of content

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of content

default

error odata.error
Up 
patch /companies({id})/contents({id1})
Update the navigation property contents in companies (companies.UpdateContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesDefaultTranslation

Up 
post /companies({id})/defaultTranslations
Create new navigation property to defaultTranslations for companies (companies.CreateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
delete /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property defaultTranslations for companies (companies.DeleteDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Get defaultTranslations from companies (companies.GetDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /companies({id})/defaultTranslations
Get defaultTranslations from companies (companies.ListDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of defaultTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of defaultTranslation

default

error odata.error
Up 
patch /companies({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property defaultTranslations in companies (companies.UpdateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesDeletedLine

Up 
post /companies({id})/deletedLines
Create new navigation property to deletedLines for companies (companies.CreateDeletedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.deletedLine (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.deletedLine

Example data

Content-Type: application/json
{
  "logId" : "string (identifier)",
  "id" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.deletedLine

default

error odata.error
Up 
delete /companies({id})/deletedLines({logId})
Delete navigation property deletedLines for companies (companies.DeleteDeletedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
logId (required)
Path Parameter — key: logId of deletedLine format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/deletedLines({logId})
Get deletedLines from companies (companies.GetDeletedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
logId (required)
Path Parameter — key: logId of deletedLine format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.deletedLine

Example data

Content-Type: application/json
{
  "logId" : "string (identifier)",
  "id" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.deletedLine

default

error odata.error
Up 
get /companies({id})/deletedLines
Get deletedLines from companies (companies.ListDeletedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of deletedLine

Example data

Content-Type: application/json
{
  "value" : [ {
    "logId" : "string (identifier)",
    "id" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)"
  }, {
    "logId" : "string (identifier)",
    "id" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of deletedLine

default

error odata.error
Up 
patch /companies({id})/deletedLines({logId})
Update the navigation property deletedLines in companies (companies.UpdateDeletedLines)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
logId (required)
Path Parameter — key: logId of deletedLine format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.deletedLine (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesDocument

Up 
post /companies({id})/documents
Create new navigation property to documents for companies (companies.CreateDocuments)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.document

default

error odata.error
Up 
delete /companies({id})/documents({id1})
Delete navigation property documents for companies (companies.DeleteDocuments)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/documents({id1})
Get documents from companies (companies.GetDocuments)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
get /companies({id})/documents
Get documents from companies (companies.ListDocuments)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of document

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of document

default

error odata.error
Up 
patch /companies({id})/documents({id1})
Update the navigation property documents in companies (companies.UpdateDocuments)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesDocumentSource

Up 
post /companies({id})/documentsSources
Create new navigation property to documentsSources for companies (companies.CreateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentSource

default

error odata.error
Up 
delete /companies({id})/documentsSources({id1})
Delete navigation property documentsSources for companies (companies.DeleteDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/documentsSources({id1})
Get documentsSources from companies (companies.GetDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentSource

default

error odata.error
Up 
get /companies({id})/documentsSources
Get documentsSources from companies (companies.ListDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentSource

default

error odata.error
Up 
patch /companies({id})/documentsSources({id1})
Update the navigation property documentsSources in companies (companies.UpdateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesDocumentTranslation

Up 
post /companies({id})/documentTranslations
Create new navigation property to documentTranslations for companies (companies.CreateDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentTranslation

default

error odata.error
Up 
delete /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property documentTranslations for companies (companies.DeleteDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Get documentTranslations from companies (companies.GetDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentTranslation

default

error odata.error
Up 
get /companies({id})/documentTranslations
Get documentTranslations from companies (companies.ListDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentTranslation

default

error odata.error
Up 
patch /companies({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property documentTranslations in companies (companies.UpdateDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesFeature

Up 
post /companies({id})/features
Create new navigation property to features for companies (companies.CreateFeatures)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.feature

default

error odata.error
Up 
delete /companies({id})/features({id1})
Delete navigation property features for companies (companies.DeleteFeatures)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/features({id1})
Get features from companies (companies.GetFeatures)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.feature

default

error odata.error
Up 
get /companies({id})/features
Get features from companies (companies.ListFeatures)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of feature

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of feature

default

error odata.error
Up 
patch /companies({id})/features({id1})
Update the navigation property features in companies (companies.UpdateFeatures)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesFeatureTranslation

Up 
post /companies({id})/featureTranslations
Create new navigation property to featureTranslations for companies (companies.CreateFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureTranslation

default

error odata.error
Up 
delete /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property featureTranslations for companies (companies.DeleteFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Get featureTranslations from companies (companies.GetFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureTranslation

default

error odata.error
Up 
get /companies({id})/featureTranslations
Get featureTranslations from companies (companies.ListFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureTranslation

default

error odata.error
Up 
patch /companies({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property featureTranslations in companies (companies.UpdateFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesFeatureValue

Up 
post /companies({id})/featuresValues
Create new navigation property to featuresValues for companies (companies.CreateFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValue (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureValue

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "entityType" : "string",
  "entityNo" : "string",
  "featureNo" : "string",
  "number" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureValue

default

error odata.error
Up 
delete /companies({id})/featuresValues({id1})
Delete navigation property featuresValues for companies (companies.DeleteFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/featuresValues({id1})
Get featuresValues from companies (companies.GetFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValue

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "entityType" : "string",
  "entityNo" : "string",
  "featureNo" : "string",
  "number" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureValue

default

error odata.error
Up 
get /companies({id})/featuresValues
Get featuresValues from companies (companies.ListFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValue

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureValue

default

error odata.error
Up 
patch /companies({id})/featuresValues({id1})
Update the navigation property featuresValues in companies (companies.UpdateFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValue (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesFeatureValueSet

Up 
post /companies({id})/featureValueSets
Create new navigation property to featureValueSets for companies (companies.CreateFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValueSet (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureValueSet

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "featureId" : "string",
  "valueId" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureValueSet

default

error odata.error
Up 
delete /companies({id})/featureValueSets({id1})
Delete navigation property featureValueSets for companies (companies.DeleteFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/featureValueSets({id1})
Get featureValueSets from companies (companies.GetFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValueSet

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "featureId" : "string",
  "valueId" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureValueSet

default

error odata.error
Up 
get /companies({id})/featureValueSets
Get featureValueSets from companies (companies.ListFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValueSet

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureValueSet

default

error odata.error
Up 
patch /companies({id})/featureValueSets({id1})
Update the navigation property featureValueSets in companies (companies.UpdateFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValueSet (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesHtmlContent

Up 
post /companies({id})/htmlContents
Create new navigation property to htmlContents for companies (companies.CreateHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.htmlContent (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.htmlContent

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "data" : "string",
  "status" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.htmlContent

default

error odata.error
Up 
delete /companies({id})/htmlContents({id1})
Delete navigation property htmlContents for companies (companies.DeleteHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/htmlContents({id1})
Get htmlContents from companies (companies.GetHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.htmlContent

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "data" : "string",
  "status" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.htmlContent

default

error odata.error
Up 
get /companies({id})/htmlContents
Get htmlContents from companies (companies.ListHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of htmlContent

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of htmlContent

default

error odata.error
Up 
patch /companies({id})/htmlContents({id1})
Update the navigation property htmlContents in companies (companies.UpdateHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.htmlContent (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesItem

Up 
post /companies({id})/items
Create new navigation property to items for companies (companies.CreateItems)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.item

default

error odata.error
Up 
delete /companies({id})/items({id1})
Delete navigation property items for companies (companies.DeleteItems)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/items({id1})
Get items from companies (companies.GetItems)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /companies({id})/items({id1})/mainPictureSource
Get media content for the navigation property items from companies (companies.GetItemsMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /companies({id})/items
Get items from companies (companies.ListItems)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of item

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  }, {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of item

default

error odata.error
Up 
patch /companies({id})/items({id1})
Update the navigation property items in companies (companies.UpdateItems)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesKeyword

Up 
post /companies({id})/keywords
Create new navigation property to keywords for companies (companies.CreateKeywords)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.keyword

default

error odata.error
Up 
delete /companies({id})/keywords({id1})
Delete navigation property keywords for companies (companies.DeleteKeywords)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/keywords({id1})
Get keywords from companies (companies.GetKeywords)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keyword

default

error odata.error
Up 
get /companies({id})/keywords
Get keywords from companies (companies.ListKeywords)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keyword

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of keyword

default

error odata.error
Up 
patch /companies({id})/keywords({id1})
Update the navigation property keywords in companies (companies.UpdateKeywords)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesKeywordTranslation

Up 
post /companies({id})/keywordTranslations
Create new navigation property to keywordTranslations for companies (companies.CreateKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keywordTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
delete /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property keywordTranslations for companies (companies.DeleteKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Get keywordTranslations from companies (companies.GetKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
get /companies({id})/keywordTranslations
Get keywordTranslations from companies (companies.ListKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keywordTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of keywordTranslation

default

error odata.error
Up 
patch /companies({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property keywordTranslations in companies (companies.UpdateKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keywordTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesPrice

Up 
post /companies({id})/prices
Create new navigation property to prices for companies (companies.CreatePrices)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.price (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.price

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationLineId" : "string",
  "code" : "string",
  "unitOfMeasure" : "string",
  "minimumQuantity" : "number",
  "currencyCode" : "string",
  "itemNo" : "string",
  "price" : "number",
  "vat" : "number",
  "priceInclVAT" : "number",
  "startingDate" : "string (timestamp)",
  "endingDate" : "string (timestamp)",
  "updatedOn" : "string (timestamp)",
  "updatedBy" : "string",
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.price

default

error odata.error
Up 
delete /companies({id})/prices({id1})
Delete navigation property prices for companies (companies.DeletePrices)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/prices({id1})
Get prices from companies (companies.GetPrices)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.price

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationLineId" : "string",
  "code" : "string",
  "unitOfMeasure" : "string",
  "minimumQuantity" : "number",
  "currencyCode" : "string",
  "itemNo" : "string",
  "price" : "number",
  "vat" : "number",
  "priceInclVAT" : "number",
  "startingDate" : "string (timestamp)",
  "endingDate" : "string (timestamp)",
  "updatedOn" : "string (timestamp)",
  "updatedBy" : "string",
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.price

default

error odata.error
Up 
get /companies({id})/prices
Get prices from companies (companies.ListPrices)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of price

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of price

default

error odata.error
Up 
patch /companies({id})/prices({id1})
Update the navigation property prices in companies (companies.UpdatePrices)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.price (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesReference

Up 
post /companies({id})/references
Create new navigation property to references for companies (companies.CreateReferences)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.reference

default

error odata.error
Up 
delete /companies({id})/references({id1})
Delete navigation property references for companies (companies.DeleteReferences)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/references({id1})
Get references from companies (companies.GetReferences)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.reference

default

error odata.error
Up 
get /companies({id})/references
Get references from companies (companies.ListReferences)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of reference

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of reference

default

error odata.error
Up 
patch /companies({id})/references({id1})
Update the navigation property references in companies (companies.UpdateReferences)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesText

Up 
post /companies({id})/texts
Create new navigation property to texts for companies (companies.CreateTexts)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.text

default

error odata.error
Up 
delete /companies({id})/texts({id1})
Delete navigation property texts for companies (companies.DeleteTexts)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/texts({id1})
Get texts from companies (companies.GetTexts)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.text

default

error odata.error
Up 
get /companies({id})/texts({id1})/source
Get media content for the navigation property texts from companies (companies.GetTextsSource)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /companies({id})/texts
Get texts from companies (companies.ListTexts)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of text

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of text

default

error odata.error
Up 
patch /companies({id})/texts({id1})
Update the navigation property texts in companies (companies.UpdateTexts)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesTextTranslation

Up 
post /companies({id})/textTranslations
Create new navigation property to textTranslations for companies (companies.CreateTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.textTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.textTranslation

default

error odata.error
Up 
delete /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property textTranslations for companies (companies.DeleteTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Get textTranslations from companies (companies.GetTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.textTranslation

default

error odata.error
Up 
get /companies({id})/textTranslations
Get textTranslations from companies (companies.ListTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of textTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of textTranslation

default

error odata.error
Up 
patch /companies({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property textTranslations in companies (companies.UpdateTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.textTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesValueTranslation

Up 
post /companies({id})/valueTranslations
Create new navigation property to valueTranslations for companies (companies.CreateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.valueTranslation

default

error odata.error
Up 
delete /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Delete navigation property valueTranslations for companies (companies.DeleteValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Get valueTranslations from companies (companies.GetValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.valueTranslation

default

error odata.error
Up 
get /companies({id})/valueTranslations
Get valueTranslations from companies (companies.ListValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of valueTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  }, {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of valueTranslation

default

error odata.error
Up 
patch /companies({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Update the navigation property valueTranslations in companies (companies.UpdateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

CompaniesVariant

Up 
post /companies({id})/variants
Create new navigation property to variants for companies (companies.CreateVariants)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.variant

default

error odata.error
Up 
delete /companies({id})/variants({id1})
Delete navigation property variants for companies (companies.DeleteVariants)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /companies({id})/variants({id1})
Get variants from companies (companies.GetVariants)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.variant

default

error odata.error
Up 
get /companies({id})/variants
Get variants from companies (companies.ListVariants)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of variant

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of variant

default

error odata.error
Up 
patch /companies({id})/variants({id1})
Update the navigation property variants in companies (companies.UpdateVariants)

Path parameters

id (required)
Path Parameter — key: id of company format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ContentsCategory

Up 
delete /contents({id})/category
Delete navigation property category for contents (contents.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /contents({id})/category
Get category from contents (contents.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /contents({id})/category/mainPictureSource
Get media content for the navigation property category from contents (contents.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /contents({id})/category
Update the navigation property category in contents (contents.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ContentsContent

Up 
get /contents({id})
Get entity from contents by key (contents.content.GetContent)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.content

default

error odata.error
Up 
get /contents
Get entities from contents (contents.content.ListContent)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of content

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of content

default

error odata.error

ContentsItem

Up 
delete /contents({id})/item
Delete navigation property item for contents (contents.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /contents({id})/item
Get item from contents (contents.GetItem)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /contents({id})/item/mainPictureSource
Get media content for the navigation property item from contents (contents.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /contents({id})/item
Update the navigation property item in contents (contents.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of content format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DefaultTranslationsCategory

Up 
delete /defaultTranslations(lineGuid={lineGuid},lang={lang})/category
Delete navigation property category for defaultTranslations (defaultTranslations.DeleteCategory)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})/category
Get category from defaultTranslations (defaultTranslations.GetCategory)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})/category/mainPictureSource
Get media content for the navigation property category from defaultTranslations (defaultTranslations.GetCategoryMainPictureSource)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /defaultTranslations(lineGuid={lineGuid},lang={lang})/category
Update the navigation property category in defaultTranslations (defaultTranslations.UpdateCategory)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DefaultTranslationsDefaultTranslation

Up 
post /defaultTranslations
Add new entity to defaultTranslations (defaultTranslations.defaultTranslation.CreateDefaultTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})
Get entity from defaultTranslations by key (defaultTranslations.defaultTranslation.GetDefaultTranslation)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /defaultTranslations
Get entities from defaultTranslations (defaultTranslations.defaultTranslation.ListDefaultTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of defaultTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of defaultTranslation

default

error odata.error

DefaultTranslationsItem

Up 
delete /defaultTranslations(lineGuid={lineGuid},lang={lang})/item
Delete navigation property item for defaultTranslations (defaultTranslations.DeleteItem)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})/item
Get item from defaultTranslations (defaultTranslations.GetItem)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})/item/mainPictureSource
Get media content for the navigation property item from defaultTranslations (defaultTranslations.GetItemMainPictureSource)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /defaultTranslations(lineGuid={lineGuid},lang={lang})/item
Update the navigation property item in defaultTranslations (defaultTranslations.UpdateItem)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DefaultTranslationsReference

Up 
delete /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference
Delete navigation property reference for defaultTranslations (defaultTranslations.DeleteReference)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference
Get reference from defaultTranslations (defaultTranslations.GetReference)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.reference

default

error odata.error
Up 
patch /defaultTranslations(lineGuid={lineGuid},lang={lang})/reference
Update the navigation property reference in defaultTranslations (defaultTranslations.UpdateReference)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DeletedLinesDeletedLine

Up 
post /deletedLines
Add new entity to deletedLines (deletedLines.deletedLine.CreateDeletedLine)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.deletedLine (required)
Body Parameter — New entity

Return type

Microsoft.NAV.deletedLine

Example data

Content-Type: application/json
{
  "logId" : "string (identifier)",
  "id" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.deletedLine

default

error odata.error
Up 
get /deletedLines({logId})
Get entity from deletedLines by key (deletedLines.deletedLine.GetDeletedLine)

Path parameters

logId (required)
Path Parameter — key: logId of deletedLine format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.deletedLine

Example data

Content-Type: application/json
{
  "logId" : "string (identifier)",
  "id" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "publicationCode" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentLineUrl" : "string",
  "dateModified" : "string (timestamp)"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.deletedLine

default

error odata.error
Up 
get /deletedLines
Get entities from deletedLines (deletedLines.deletedLine.ListDeletedLine)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of deletedLine

Example data

Content-Type: application/json
{
  "value" : [ {
    "logId" : "string (identifier)",
    "id" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)"
  }, {
    "logId" : "string (identifier)",
    "id" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "publicationCode" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentLineUrl" : "string",
    "dateModified" : "string (timestamp)"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of deletedLine

default

error odata.error

DocumentTranslationsDocument

Up 
delete /documentTranslations(lineGuid={lineGuid},lang={lang})/document
Delete navigation property document for documentTranslations (documentTranslations.DeleteDocument)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documentTranslations(lineGuid={lineGuid},lang={lang})/document
Get document from documentTranslations (documentTranslations.GetDocument)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
patch /documentTranslations(lineGuid={lineGuid},lang={lang})/document
Update the navigation property document in documentTranslations (documentTranslations.UpdateDocument)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentTranslationsDocumentTranslation

Up 
post /documentTranslations
Add new entity to documentTranslations (documentTranslations.documentTranslation.CreateDocumentTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.documentTranslation

default

error odata.error
Up 
get /documentTranslations(lineGuid={lineGuid},lang={lang})
Get entity from documentTranslations by key (documentTranslations.documentTranslation.GetDocumentTranslation)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.documentTranslation

default

error odata.error
Up 
get /documentTranslations
Get entities from documentTranslations (documentTranslations.documentTranslation.ListDocumentTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of documentTranslation

default

error odata.error

DocumentsCategory

Up 
delete /documents({id})/category
Delete navigation property category for documents (documents.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/category
Get category from documents (documents.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /documents({id})/category/mainPictureSource
Get media content for the navigation property category from documents (documents.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /documents({id})/category
Update the navigation property category in documents (documents.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentsDocument

Up 
get /documents({id})
Get entity from documents by key (documents.document.GetDocument)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.document

default

error odata.error
Up 
get /documents
Get entities from documents (documents.document.ListDocument)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of document

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of document

default

error odata.error

DocumentsDocumentSource

Up 
post /documents({id})/documentsSources
Create new navigation property to documentsSources for documents (documents.CreateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentSource

default

error odata.error
Up 
delete /documents({id})/documentsSources({id1})
Delete navigation property documentsSources for documents (documents.DeleteDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/documentsSources({id1})
Get documentsSources from documents (documents.GetDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentSource

default

error odata.error
Up 
get /documents({id})/documentsSources
Get documentsSources from documents (documents.ListDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentSource

default

error odata.error
Up 
patch /documents({id})/documentsSources({id1})
Update the navigation property documentsSources in documents (documents.UpdateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentsDocumentTranslation

Up 
post /documents({id})/documentTranslations
Create new navigation property to documentTranslations for documents (documents.CreateDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentTranslation

default

error odata.error
Up 
delete /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property documentTranslations for documents (documents.DeleteDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Get documentTranslations from documents (documents.GetDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentTranslation

default

error odata.error
Up 
get /documents({id})/documentTranslations
Get documentTranslations from documents (documents.ListDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentTranslation

default

error odata.error
Up 
patch /documents({id})/documentTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property documentTranslations in documents (documents.UpdateDocumentTranslations)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of documentTranslation format: uuid
lang (required)
Path Parameter — key: lang of documentTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentsItem

Up 
delete /documents({id})/item
Delete navigation property item for documents (documents.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/item
Get item from documents (documents.GetItem)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /documents({id})/item/mainPictureSource
Get media content for the navigation property item from documents (documents.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /documents({id})/item
Update the navigation property item in documents (documents.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentsSourcesDocumentSource

Up 
post /documentsSources
Add new entity to documentsSources (documentsSources.documentSource.CreateDocumentSource)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New entity

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.documentSource

default

error odata.error
Up 
get /documentsSources({id})
Get entity from documentsSources by key (documentsSources.documentSource.GetDocumentSource)

Path parameters

id (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.documentSource

default

error odata.error
Up 
get /documentsSources
Get entities from documentsSources (documentsSources.documentSource.ListDocumentSource)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of documentSource

default

error odata.error

DocumentsText

Up 
post /documents({id})/texts
Create new navigation property to texts for documents (documents.CreateTexts)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.text

default

error odata.error
Up 
delete /documents({id})/texts({id1})
Delete navigation property texts for documents (documents.DeleteTexts)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/texts({id1})
Get texts from documents (documents.GetTexts)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.text

default

error odata.error
Up 
get /documents({id})/texts({id1})/source
Get media content for the navigation property texts from documents (documents.GetTextsSource)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /documents({id})/texts
Get texts from documents (documents.ListTexts)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of text

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of text

default

error odata.error
Up 
patch /documents({id})/texts({id1})
Update the navigation property texts in documents (documents.UpdateTexts)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

DocumentsVariant

Up 
delete /documents({id})/variant
Delete navigation property variant for documents (documents.DeleteVariant)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /documents({id})/variant
Get variant from documents (documents.GetVariant)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.variant

default

error odata.error
Up 
patch /documents({id})/variant
Update the navigation property variant in documents (documents.UpdateVariant)

Path parameters

id (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

EntityDefinitionsEntityMetadata

Up 
post /entityDefinitions
Add new entity to entityDefinitions (entityDefinitions.entityMetadata.CreateEntityMetadata)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.entityMetadata (required)
Body Parameter — New entity

Return type

Microsoft.NAV.entityMetadata

Example data

Content-Type: application/json
{
  "entityName" : "string (identifier)",
  "entitySetName" : "string",
  "entityCaptions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
  } ],
  "entitySetCaptions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
  } ],
  "properties" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataField"
  } ],
  "actions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataAction"
  } ],
  "enumMembers" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataEnumMember"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.entityMetadata

default

error odata.error
Up 
delete /entityDefinitions({entityName})
Delete entity from entityDefinitions (entityDefinitions.entityMetadata.DeleteEntityMetadata)

Path parameters

entityName (required)
Path Parameter — key: entityName of entityMetadata

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /entityDefinitions({entityName})
Get entity from entityDefinitions by key (entityDefinitions.entityMetadata.GetEntityMetadata)

Path parameters

entityName (required)
Path Parameter — key: entityName of entityMetadata

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.entityMetadata

Example data

Content-Type: application/json
{
  "entityName" : "string (identifier)",
  "entitySetName" : "string",
  "entityCaptions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
  } ],
  "entitySetCaptions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
  } ],
  "properties" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataField"
  } ],
  "actions" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataAction"
  } ],
  "enumMembers" : [ {
    "@odata.type" : "Microsoft.NAV.entityMetadataEnumMember"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.entityMetadata

default

error odata.error
Up 
get /entityDefinitions
Get entities from entityDefinitions (entityDefinitions.entityMetadata.ListEntityMetadata)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of entityMetadata

Example data

Content-Type: application/json
{
  "value" : [ {
    "entityName" : "string (identifier)",
    "entitySetName" : "string",
    "entityCaptions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
    } ],
    "entitySetCaptions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
    } ],
    "properties" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataField"
    } ],
    "actions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataAction"
    } ],
    "enumMembers" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataEnumMember"
    } ]
  }, {
    "entityName" : "string (identifier)",
    "entitySetName" : "string",
    "entityCaptions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
    } ],
    "entitySetCaptions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataLabel"
    } ],
    "properties" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataField"
    } ],
    "actions" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataAction"
    } ],
    "enumMembers" : [ {
      "@odata.type" : "Microsoft.NAV.entityMetadataEnumMember"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of entityMetadata

default

error odata.error
Up 
patch /entityDefinitions({entityName})
Update entity in entityDefinitions (entityDefinitions.entityMetadata.UpdateEntityMetadata)

Path parameters

entityName (required)
Path Parameter — key: entityName of entityMetadata

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.entityMetadata (required)
Body Parameter — New property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ExternalbusinesseventdefinitionsExternalbusinesseventdefinitions

Up 
get /externalbusinesseventdefinitions(appId={appId},name={name},eventVersion={eventVersion})
Get entity from externalbusinesseventdefinitions by key (externalbusinesseventdefinitions.externalbusinesseventdefinitions.GetExternalbusinesseventdefinitions)

Path parameters

appId (required)
Path Parameter — key: appId of externalbusinesseventdefinitions format: uuid
name (required)
Path Parameter — key: name of externalbusinesseventdefinitions
eventVersion (required)
Path Parameter — key: eventVersion of externalbusinesseventdefinitions

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.externalbusinesseventdefinitions

Example data

Content-Type: application/json
{
  "appId" : "string (identifier)",
  "name" : "string (identifier)",
  "eventVersion" : "string (identifier)",
  "isObsolete" : true,
  "obsoleteReason" : "string",
  "obsoleteTag" : "string",
  "payload" : "string",
  "displayName" : "string",
  "description" : "string",
  "category" : "string",
  "appName" : "string",
  "appPublisher" : "string",
  "appVersion" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.externalbusinesseventdefinitions

default

error odata.error
Up 
get /externalbusinesseventdefinitions
Get entities from externalbusinesseventdefinitions (externalbusinesseventdefinitions.externalbusinesseventdefinitions.ListExternalbusinesseventdefinitions)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of externalbusinesseventdefinitions

Example data

Content-Type: application/json
{
  "value" : [ {
    "appId" : "string (identifier)",
    "name" : "string (identifier)",
    "eventVersion" : "string (identifier)",
    "isObsolete" : true,
    "obsoleteReason" : "string",
    "obsoleteTag" : "string",
    "payload" : "string",
    "displayName" : "string",
    "description" : "string",
    "category" : "string",
    "appName" : "string",
    "appPublisher" : "string",
    "appVersion" : "string"
  }, {
    "appId" : "string (identifier)",
    "name" : "string (identifier)",
    "eventVersion" : "string (identifier)",
    "isObsolete" : true,
    "obsoleteReason" : "string",
    "obsoleteTag" : "string",
    "payload" : "string",
    "displayName" : "string",
    "description" : "string",
    "category" : "string",
    "appName" : "string",
    "appPublisher" : "string",
    "appVersion" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of externalbusinesseventdefinitions

default

error odata.error

ExternaleventsubscriptionsExternaleventsubscriptions

Up 
post /externaleventsubscriptions
Add new entity to externaleventsubscriptions (externaleventsubscriptions.externaleventsubscriptions.CreateExternaleventsubscriptions)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.externaleventsubscriptions (required)
Body Parameter — New entity

Return type

Microsoft.NAV.externaleventsubscriptions

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "companyId" : "string",
  "timestamp" : "integer",
  "appId" : "string",
  "eventName" : "string",
  "companyName" : "string",
  "userId" : "string",
  "notificationUrl" : "string",
  "lastModifiedDateTime" : "string (timestamp)",
  "clientState" : "string",
  "subscriptionType" : "string",
  "eventVersion" : "string",
  "subscriptionState" : "string",
  "systemCreatedAt" : "string (timestamp)",
  "systemCreatedBy" : "string",
  "systemModifiedAt" : "string (timestamp)",
  "systemModifiedBy" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.externaleventsubscriptions

default

error odata.error
Up 
delete /externaleventsubscriptions({id})
Delete entity from externaleventsubscriptions (externaleventsubscriptions.externaleventsubscriptions.DeleteExternaleventsubscriptions)

Path parameters

id (required)
Path Parameter — key: id of externaleventsubscriptions format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /externaleventsubscriptions({id})
Get entity from externaleventsubscriptions by key (externaleventsubscriptions.externaleventsubscriptions.GetExternaleventsubscriptions)

Path parameters

id (required)
Path Parameter — key: id of externaleventsubscriptions format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.externaleventsubscriptions

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "companyId" : "string",
  "timestamp" : "integer",
  "appId" : "string",
  "eventName" : "string",
  "companyName" : "string",
  "userId" : "string",
  "notificationUrl" : "string",
  "lastModifiedDateTime" : "string (timestamp)",
  "clientState" : "string",
  "subscriptionType" : "string",
  "eventVersion" : "string",
  "subscriptionState" : "string",
  "systemCreatedAt" : "string (timestamp)",
  "systemCreatedBy" : "string",
  "systemModifiedAt" : "string (timestamp)",
  "systemModifiedBy" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.externaleventsubscriptions

default

error odata.error
Up 
get /externaleventsubscriptions
Get entities from externaleventsubscriptions (externaleventsubscriptions.externaleventsubscriptions.ListExternaleventsubscriptions)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of externaleventsubscriptions

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "companyId" : "string",
    "timestamp" : "integer",
    "appId" : "string",
    "eventName" : "string",
    "companyName" : "string",
    "userId" : "string",
    "notificationUrl" : "string",
    "lastModifiedDateTime" : "string (timestamp)",
    "clientState" : "string",
    "subscriptionType" : "string",
    "eventVersion" : "string",
    "subscriptionState" : "string",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string"
  }, {
    "id" : "string (identifier)",
    "companyId" : "string",
    "timestamp" : "integer",
    "appId" : "string",
    "eventName" : "string",
    "companyName" : "string",
    "userId" : "string",
    "notificationUrl" : "string",
    "lastModifiedDateTime" : "string (timestamp)",
    "clientState" : "string",
    "subscriptionType" : "string",
    "eventVersion" : "string",
    "subscriptionState" : "string",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of externaleventsubscriptions

default

error odata.error
Up 
patch /externaleventsubscriptions({id})
Update entity in externaleventsubscriptions (externaleventsubscriptions.externaleventsubscriptions.UpdateExternaleventsubscriptions)

Path parameters

id (required)
Path Parameter — key: id of externaleventsubscriptions format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.externaleventsubscriptions (required)
Body Parameter — New property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeatureTranslationsFeature

Up 
delete /featureTranslations(lineGuid={lineGuid},lang={lang})/feature
Delete navigation property feature for featureTranslations (featureTranslations.DeleteFeature)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /featureTranslations(lineGuid={lineGuid},lang={lang})/feature
Get feature from featureTranslations (featureTranslations.GetFeature)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.feature

default

error odata.error
Up 
patch /featureTranslations(lineGuid={lineGuid},lang={lang})/feature
Update the navigation property feature in featureTranslations (featureTranslations.UpdateFeature)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeatureTranslationsFeatureTranslation

Up 
post /featureTranslations
Add new entity to featureTranslations (featureTranslations.featureTranslation.CreateFeatureTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.featureTranslation

default

error odata.error
Up 
get /featureTranslations(lineGuid={lineGuid},lang={lang})
Get entity from featureTranslations by key (featureTranslations.featureTranslation.GetFeatureTranslation)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.featureTranslation

default

error odata.error
Up 
get /featureTranslations
Get entities from featureTranslations (featureTranslations.featureTranslation.ListFeatureTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of featureTranslation

default

error odata.error

FeatureValueSetsFeatureValueSet

Up 
get /featureValueSets({id})
Get entity from featureValueSets by key (featureValueSets.featureValueSet.GetFeatureValueSet)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValueSet

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "featureId" : "string",
  "valueId" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.featureValueSet

default

error odata.error
Up 
get /featureValueSets
Get entities from featureValueSets (featureValueSets.featureValueSet.ListFeatureValueSet)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValueSet

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of featureValueSet

default

error odata.error

FeatureValueSetsValueTranslation

Up 
post /featureValueSets({id})/valueTranslations
Create new navigation property to valueTranslations for featureValueSets (featureValueSets.CreateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.valueTranslation

default

error odata.error
Up 
delete /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Delete navigation property valueTranslations for featureValueSets (featureValueSets.DeleteValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Get valueTranslations from featureValueSets (featureValueSets.GetValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.valueTranslation

default

error odata.error
Up 
get /featureValueSets({id})/valueTranslations
Get valueTranslations from featureValueSets (featureValueSets.ListValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of valueTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  }, {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of valueTranslation

default

error odata.error
Up 
patch /featureValueSets({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Update the navigation property valueTranslations in featureValueSets (featureValueSets.UpdateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValueSet format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesCategory

Up 
delete /features({id})/category
Delete navigation property category for features (features.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /features({id})/category
Get category from features (features.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /features({id})/category/mainPictureSource
Get media content for the navigation property category from features (features.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /features({id})/category
Update the navigation property category in features (features.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesFeature

Up 
get /features({id})
Get entity from features by key (features.feature.GetFeature)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.feature

default

error odata.error
Up 
get /features
Get entities from features (features.feature.ListFeature)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of feature

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of feature

default

error odata.error

FeaturesFeatureTranslation

Up 
post /features({id})/featureTranslations
Create new navigation property to featureTranslations for features (features.CreateFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureTranslation

default

error odata.error
Up 
delete /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property featureTranslations for features (features.DeleteFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Get featureTranslations from features (features.GetFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "value" : "string",
  "unitShorthand" : "string",
  "unitDescription" : "string",
  "feature" : {
    "@odata.type" : "Microsoft.NAV.feature"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureTranslation

default

error odata.error
Up 
get /features({id})/featureTranslations
Get featureTranslations from features (features.ListFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "value" : "string",
    "unitShorthand" : "string",
    "unitDescription" : "string",
    "feature" : {
      "@odata.type" : "Microsoft.NAV.feature"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureTranslation

default

error odata.error
Up 
patch /features({id})/featureTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property featureTranslations in features (features.UpdateFeatureTranslations)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of featureTranslation format: uuid
lang (required)
Path Parameter — key: lang of featureTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesFeatureValue

Up 
post /features({id})/featuresValues
Create new navigation property to featuresValues for features (features.CreateFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValue (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureValue

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "entityType" : "string",
  "entityNo" : "string",
  "featureNo" : "string",
  "number" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureValue

default

error odata.error
Up 
delete /features({id})/featuresValues({id1})
Delete navigation property featuresValues for features (features.DeleteFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /features({id})/featuresValues({id1})
Get featuresValues from features (features.GetFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValue

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "entityType" : "string",
  "entityNo" : "string",
  "featureNo" : "string",
  "number" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureValue

default

error odata.error
Up 
get /features({id})/featuresValues
Get featuresValues from features (features.ListFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValue

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureValue

default

error odata.error
Up 
patch /features({id})/featuresValues({id1})
Update the navigation property featuresValues in features (features.UpdateFeaturesValues)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValue format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValue (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesFeatureValueSet

Up 
post /features({id})/featureValueSets
Create new navigation property to featureValueSets for features (features.CreateFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValueSet (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.featureValueSet

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "featureId" : "string",
  "valueId" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.featureValueSet

default

error odata.error
Up 
delete /features({id})/featureValueSets({id1})
Delete navigation property featureValueSets for features (features.DeleteFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /features({id})/featureValueSets({id1})
Get featureValueSets from features (features.GetFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValueSet

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "featureId" : "string",
  "valueId" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.featureValueSet

default

error odata.error
Up 
get /features({id})/featureValueSets
Get featureValueSets from features (features.ListFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValueSet

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "featureId" : "string",
    "valueId" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of featureValueSet

default

error odata.error
Up 
patch /features({id})/featureValueSets({id1})
Update the navigation property featureValueSets in features (features.UpdateFeatureValueSets)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid
id1 (required)
Path Parameter — key: id of featureValueSet format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.featureValueSet (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesItem

Up 
delete /features({id})/item
Delete navigation property item for features (features.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /features({id})/item
Get item from features (features.GetItem)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /features({id})/item/mainPictureSource
Get media content for the navigation property item from features (features.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /features({id})/item
Update the navigation property item in features (features.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

FeaturesValuesFeatureValue

Up 
get /featuresValues({id})
Get entity from featuresValues by key (featuresValues.featureValue.GetFeatureValue)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.featureValue

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "entityType" : "string",
  "entityNo" : "string",
  "featureNo" : "string",
  "number" : "string",
  "value" : "string",
  "valueTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.valueTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.featureValue

default

error odata.error
Up 
get /featuresValues
Get entities from featuresValues (featuresValues.featureValue.ListFeatureValue)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of featureValue

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "entityType" : "string",
    "entityNo" : "string",
    "featureNo" : "string",
    "number" : "string",
    "value" : "string",
    "valueTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.valueTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of featureValue

default

error odata.error

FeaturesValuesValueTranslation

Up 
post /featuresValues({id})/valueTranslations
Create new navigation property to valueTranslations for featuresValues (featuresValues.CreateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.valueTranslation

default

error odata.error
Up 
delete /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Delete navigation property valueTranslations for featuresValues (featuresValues.DeleteValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Get valueTranslations from featuresValues (featuresValues.GetValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.valueTranslation

default

error odata.error
Up 
get /featuresValues({id})/valueTranslations
Get valueTranslations from featuresValues (featuresValues.ListValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of valueTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  }, {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of valueTranslation

default

error odata.error
Up 
patch /featuresValues({id})/valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Update the navigation property valueTranslations in featuresValues (featuresValues.UpdateValueTranslations)

Path parameters

id (required)
Path Parameter — key: id of featureValue format: uuid
type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

HtmlContentsHtmlContent

Up 
get /htmlContents({id})
Get entity from htmlContents by key (htmlContents.htmlContent.GetHtmlContent)

Path parameters

id (required)
Path Parameter — key: id of htmlContent format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.htmlContent

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "data" : "string",
  "status" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.htmlContent

default

error odata.error
Up 
get /htmlContents
Get entities from htmlContents (htmlContents.htmlContent.ListHtmlContent)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of htmlContent

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of htmlContent

default

error odata.error

ItemsCategory

Up 
delete /items({id})/category
Delete navigation property category for items (items.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/category
Get category from items (items.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /items({id})/category/mainPictureSource
Get media content for the navigation property category from items (items.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /items({id})/category
Update the navigation property category in items (items.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsContent

Up 
post /items({id})/contents
Create new navigation property to contents for items (items.CreateContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.content

default

error odata.error
Up 
delete /items({id})/contents({id1})
Delete navigation property contents for items (items.DeleteContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/contents({id1})
Get contents from items (items.GetContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.content

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "lineId" : "string",
  "lineType" : "string",
  "lineEntityUrl" : "string",
  "parentLineId" : "string",
  "parentLineType" : "string",
  "parentEntityUrl" : "string",
  "templateCode" : "string",
  "level" : "integer",
  "lineNo" : "integer",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.content

default

error odata.error
Up 
get /items({id})/contents
Get contents from items (items.ListContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of content

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "lineId" : "string",
    "lineType" : "string",
    "lineEntityUrl" : "string",
    "parentLineId" : "string",
    "parentLineType" : "string",
    "parentEntityUrl" : "string",
    "templateCode" : "string",
    "level" : "integer",
    "lineNo" : "integer",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of content

default

error odata.error
Up 
patch /items({id})/contents({id1})
Update the navigation property contents in items (items.UpdateContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of content format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.content (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsDefaultTranslation

Up 
post /items({id})/defaultTranslations
Create new navigation property to defaultTranslations for items (items.CreateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
delete /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property defaultTranslations for items (items.DeleteDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Get defaultTranslations from items (items.GetDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /items({id})/defaultTranslations
Get defaultTranslations from items (items.ListDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of defaultTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of defaultTranslation

default

error odata.error
Up 
patch /items({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property defaultTranslations in items (items.UpdateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsDocument

Up 
post /items({id})/documents
Create new navigation property to documents for items (items.CreateDocuments)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.document

default

error odata.error
Up 
delete /items({id})/documents({id1})
Delete navigation property documents for items (items.DeleteDocuments)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/documents({id1})
Get documents from items (items.GetDocuments)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
get /items({id})/documents
Get documents from items (items.ListDocuments)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of document

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of document

default

error odata.error
Up 
patch /items({id})/documents({id1})
Update the navigation property documents in items (items.UpdateDocuments)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsDocumentSource

Up 
post /items({id})/documentsSources
Create new navigation property to documentsSources for items (items.CreateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentSource

default

error odata.error
Up 
delete /items({id})/documentsSources({id1})
Delete navigation property documentsSources for items (items.DeleteDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/documentsSources({id1})
Get documentsSources from items (items.GetDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentSource

default

error odata.error
Up 
get /items({id})/documentsSources
Get documentsSources from items (items.ListDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentSource

default

error odata.error
Up 
patch /items({id})/documentsSources({id1})
Update the navigation property documentsSources in items (items.UpdateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsFeature

Up 
post /items({id})/features
Create new navigation property to features for items (items.CreateFeatures)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.feature

default

error odata.error
Up 
delete /items({id})/features({id1})
Delete navigation property features for items (items.DeleteFeatures)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/features({id1})
Get features from items (items.GetFeatures)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.feature

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "lineType" : "string",
  "description" : "string",
  "valueId" : "string",
  "value" : "string",
  "textValue" : "string",
  "fromValue" : "number",
  "toValue" : "number",
  "unitCode" : "string",
  "unit" : "string",
  "unitShorthand" : "string",
  "classification" : "string",
  "type" : "string",
  "order" : "integer",
  "polyvalent" : true,
  "featureType" : {
    "@odata.type" : "Microsoft.NAV.pimxFeatureType"
  },
  "parentItemNo" : "string",
  "dataId" : "string",
  "valueSearchDescription" : "string",
  "importance" : {
    "@odata.type" : "Microsoft.NAV.pimxImportance"
  },
  "relevance" : {
    "@odata.type" : "Microsoft.NAV.pimxRelevance"
  },
  "valueSetId" : "integer",
  "sorting" : "integer",
  "element" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "usageTypeCode" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "featuresValues" : [ {
    "@odata.type" : "Microsoft.NAV.featureValue"
  } ],
  "featureValueSets" : [ {
    "@odata.type" : "Microsoft.NAV.featureValueSet"
  } ],
  "featureTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.featureTranslation"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.feature

default

error odata.error
Up 
get /items({id})/features
Get features from items (items.ListFeatures)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of feature

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "lineType" : "string",
    "description" : "string",
    "valueId" : "string",
    "value" : "string",
    "textValue" : "string",
    "fromValue" : "number",
    "toValue" : "number",
    "unitCode" : "string",
    "unit" : "string",
    "unitShorthand" : "string",
    "classification" : "string",
    "type" : "string",
    "order" : "integer",
    "polyvalent" : true,
    "featureType" : {
      "@odata.type" : "Microsoft.NAV.pimxFeatureType"
    },
    "parentItemNo" : "string",
    "dataId" : "string",
    "valueSearchDescription" : "string",
    "importance" : {
      "@odata.type" : "Microsoft.NAV.pimxImportance"
    },
    "relevance" : {
      "@odata.type" : "Microsoft.NAV.pimxRelevance"
    },
    "valueSetId" : "integer",
    "sorting" : "integer",
    "element" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "usageTypeCode" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "featuresValues" : [ {
      "@odata.type" : "Microsoft.NAV.featureValue"
    } ],
    "featureValueSets" : [ {
      "@odata.type" : "Microsoft.NAV.featureValueSet"
    } ],
    "featureTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.featureTranslation"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of feature

default

error odata.error
Up 
patch /items({id})/features({id1})
Update the navigation property features in items (items.UpdateFeatures)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of feature format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.feature (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsHtmlContent

Up 
post /items({id})/htmlContents
Create new navigation property to htmlContents for items (items.CreateHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.htmlContent (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.htmlContent

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "data" : "string",
  "status" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.htmlContent

default

error odata.error
Up 
delete /items({id})/htmlContents({id1})
Delete navigation property htmlContents for items (items.DeleteHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/htmlContents({id1})
Get htmlContents from items (items.GetHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.htmlContent

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "data" : "string",
  "status" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.htmlContent

default

error odata.error
Up 
get /items({id})/htmlContents
Get htmlContents from items (items.ListHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of htmlContent

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  }, {
    "id" : "string (identifier)",
    "publicationCode" : "string",
    "data" : "string",
    "status" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of htmlContent

default

error odata.error
Up 
patch /items({id})/htmlContents({id1})
Update the navigation property htmlContents in items (items.UpdateHtmlContents)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of htmlContent format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.htmlContent (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsItem

Up 
post /items
Add new entity to items (items.item.CreateItem)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New entity

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.item

default

error odata.error
Up 
get /items({id})
Get entity from items by key (items.item.GetItem)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.item

default

error odata.error
Up 
get /items({id})/mainPictureSource
Get media content for item from items (items.item.GetMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /items
Get entities from items (items.item.ListItem)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of item

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  }, {
    "id" : "string (identifier)",
    "sisterLineId" : "string",
    "itemId" : "string",
    "type" : "string",
    "publicationCode" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "mainPictureSource" : "string",
    "element" : "string",
    "categoryId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "features" : [ {
      "@odata.type" : "Microsoft.NAV.feature"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "references" : [ {
      "@odata.type" : "Microsoft.NAV.reference"
    } ],
    "keywords" : [ {
      "@odata.type" : "Microsoft.NAV.keyword"
    } ],
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ],
    "contents" : [ {
      "@odata.type" : "Microsoft.NAV.content"
    } ],
    "htmlContents" : [ {
      "@odata.type" : "Microsoft.NAV.htmlContent"
    } ],
    "variants" : [ {
      "@odata.type" : "Microsoft.NAV.variant"
    } ],
    "prices" : [ {
      "@odata.type" : "Microsoft.NAV.price"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of item

default

error odata.error

ItemsKeyword

Up 
post /items({id})/keywords
Create new navigation property to keywords for items (items.CreateKeywords)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.keyword

default

error odata.error
Up 
delete /items({id})/keywords({id1})
Delete navigation property keywords for items (items.DeleteKeywords)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/keywords({id1})
Get keywords from items (items.GetKeywords)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keyword

default

error odata.error
Up 
get /items({id})/keywords
Get keywords from items (items.ListKeywords)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keyword

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of keyword

default

error odata.error
Up 
patch /items({id})/keywords({id1})
Update the navigation property keywords in items (items.UpdateKeywords)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsPrice

Up 
post /items({id})/prices
Create new navigation property to prices for items (items.CreatePrices)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.price (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.price

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationLineId" : "string",
  "code" : "string",
  "unitOfMeasure" : "string",
  "minimumQuantity" : "number",
  "currencyCode" : "string",
  "itemNo" : "string",
  "price" : "number",
  "vat" : "number",
  "priceInclVAT" : "number",
  "startingDate" : "string (timestamp)",
  "endingDate" : "string (timestamp)",
  "updatedOn" : "string (timestamp)",
  "updatedBy" : "string",
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.price

default

error odata.error
Up 
delete /items({id})/prices({id1})
Delete navigation property prices for items (items.DeletePrices)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/prices({id1})
Get prices from items (items.GetPrices)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.price

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationLineId" : "string",
  "code" : "string",
  "unitOfMeasure" : "string",
  "minimumQuantity" : "number",
  "currencyCode" : "string",
  "itemNo" : "string",
  "price" : "number",
  "vat" : "number",
  "priceInclVAT" : "number",
  "startingDate" : "string (timestamp)",
  "endingDate" : "string (timestamp)",
  "updatedOn" : "string (timestamp)",
  "updatedBy" : "string",
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.price

default

error odata.error
Up 
get /items({id})/prices
Get prices from items (items.ListPrices)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of price

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of price

default

error odata.error
Up 
patch /items({id})/prices({id1})
Update the navigation property prices in items (items.UpdatePrices)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of price format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.price (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsReference

Up 
post /items({id})/references
Create new navigation property to references for items (items.CreateReferences)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.reference

default

error odata.error
Up 
delete /items({id})/references({id1})
Delete navigation property references for items (items.DeleteReferences)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/references({id1})
Get references from items (items.GetReferences)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.reference

default

error odata.error
Up 
get /items({id})/references
Get references from items (items.ListReferences)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of reference

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of reference

default

error odata.error
Up 
patch /items({id})/references({id1})
Update the navigation property references in items (items.UpdateReferences)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsText

Up 
post /items({id})/texts
Create new navigation property to texts for items (items.CreateTexts)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.text

default

error odata.error
Up 
delete /items({id})/texts({id1})
Delete navigation property texts for items (items.DeleteTexts)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/texts({id1})
Get texts from items (items.GetTexts)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.text

default

error odata.error
Up 
get /items({id})/texts({id1})/source
Get media content for the navigation property texts from items (items.GetTextsSource)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /items({id})/texts
Get texts from items (items.ListTexts)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of text

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of text

default

error odata.error
Up 
patch /items({id})/texts({id1})
Update the navigation property texts in items (items.UpdateTexts)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ItemsVariant

Up 
post /items({id})/variants
Create new navigation property to variants for items (items.CreateVariants)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.variant

default

error odata.error
Up 
delete /items({id})/variants({id1})
Delete navigation property variants for items (items.DeleteVariants)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /items({id})/variants({id1})
Get variants from items (items.GetVariants)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.variant

default

error odata.error
Up 
get /items({id})/variants
Get variants from items (items.ListVariants)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of variant

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of variant

default

error odata.error
Up 
patch /items({id})/variants({id1})
Update the navigation property variants in items (items.UpdateVariants)

Path parameters

id (required)
Path Parameter — key: id of item format: uuid
id1 (required)
Path Parameter — key: id of variant format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

KeywordTranslationsKeyword

Up 
delete /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword
Delete navigation property keyword for keywordTranslations (keywordTranslations.DeleteKeyword)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword
Get keyword from keywordTranslations (keywordTranslations.GetKeyword)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keyword

default

error odata.error
Up 
patch /keywordTranslations(lineGuid={lineGuid},lang={lang})/keyword
Update the navigation property keyword in keywordTranslations (keywordTranslations.UpdateKeyword)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

KeywordTranslationsKeywordTranslation

Up 
post /keywordTranslations
Add new entity to keywordTranslations (keywordTranslations.keywordTranslation.CreateKeywordTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keywordTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
get /keywordTranslations(lineGuid={lineGuid},lang={lang})
Get entity from keywordTranslations by key (keywordTranslations.keywordTranslation.GetKeywordTranslation)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
get /keywordTranslations
Get entities from keywordTranslations (keywordTranslations.keywordTranslation.ListKeywordTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keywordTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of keywordTranslation

default

error odata.error

KeywordsCategory

Up 
delete /keywords({id})/category
Delete navigation property category for keywords (keywords.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /keywords({id})/category
Get category from keywords (keywords.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /keywords({id})/category/mainPictureSource
Get media content for the navigation property category from keywords (keywords.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /keywords({id})/category
Update the navigation property category in keywords (keywords.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

KeywordsItem

Up 
delete /keywords({id})/item
Delete navigation property item for keywords (keywords.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /keywords({id})/item
Get item from keywords (keywords.GetItem)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /keywords({id})/item/mainPictureSource
Get media content for the navigation property item from keywords (keywords.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /keywords({id})/item
Update the navigation property item in keywords (keywords.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

KeywordsKeyword

Up 
post /keywords
Add new entity to keywords (keywords.keyword.CreateKeyword)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keyword (required)
Body Parameter — New entity

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.keyword

default

error odata.error
Up 
get /keywords({id})
Get entity from keywords by key (keywords.keyword.GetKeyword)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keyword

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "keywordTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.keywordTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.keyword

default

error odata.error
Up 
get /keywords
Get entities from keywords (keywords.keyword.ListKeyword)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keyword

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "keywordTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.keywordTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of keyword

default

error odata.error

KeywordsKeywordTranslation

Up 
post /keywords({id})/keywordTranslations
Create new navigation property to keywordTranslations for keywords (keywords.CreateKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keywordTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
delete /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property keywordTranslations for keywords (keywords.DeleteKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Get keywordTranslations from keywords (keywords.GetKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.keywordTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "keyword" : {
    "@odata.type" : "Microsoft.NAV.keyword"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.keywordTranslation

default

error odata.error
Up 
get /keywords({id})/keywordTranslations
Get keywordTranslations from keywords (keywords.ListKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of keywordTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "keyword" : {
      "@odata.type" : "Microsoft.NAV.keyword"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of keywordTranslation

default

error odata.error
Up 
patch /keywords({id})/keywordTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property keywordTranslations in keywords (keywords.UpdateKeywordTranslations)

Path parameters

id (required)
Path Parameter — key: id of keyword format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of keywordTranslation format: uuid
lang (required)
Path Parameter — key: lang of keywordTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.keywordTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

PricesItem

Up 
delete /prices({id})/item
Delete navigation property item for prices (prices.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of price format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /prices({id})/item
Get item from prices (prices.GetItem)

Path parameters

id (required)
Path Parameter — key: id of price format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /prices({id})/item/mainPictureSource
Get media content for the navigation property item from prices (prices.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of price format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /prices({id})/item
Update the navigation property item in prices (prices.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of price format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

PricesPrice

Up 
get /prices({id})
Get entity from prices by key (prices.price.GetPrice)

Path parameters

id (required)
Path Parameter — key: id of price format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.price

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationLineId" : "string",
  "code" : "string",
  "unitOfMeasure" : "string",
  "minimumQuantity" : "number",
  "currencyCode" : "string",
  "itemNo" : "string",
  "price" : "number",
  "vat" : "number",
  "priceInclVAT" : "number",
  "startingDate" : "string (timestamp)",
  "endingDate" : "string (timestamp)",
  "updatedOn" : "string (timestamp)",
  "updatedBy" : "string",
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.price

default

error odata.error
Up 
get /prices
Get entities from prices (prices.price.ListPrice)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of price

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "publicationLineId" : "string",
    "code" : "string",
    "unitOfMeasure" : "string",
    "minimumQuantity" : "number",
    "currencyCode" : "string",
    "itemNo" : "string",
    "price" : "number",
    "vat" : "number",
    "priceInclVAT" : "number",
    "startingDate" : "string (timestamp)",
    "endingDate" : "string (timestamp)",
    "updatedOn" : "string (timestamp)",
    "updatedBy" : "string",
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of price

default

error odata.error

ReferencesCategory

Up 
delete /references({id})/category
Delete navigation property category for references (references.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /references({id})/category
Get category from references (references.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /references({id})/category/mainPictureSource
Get media content for the navigation property category from references (references.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /references({id})/category
Update the navigation property category in references (references.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ReferencesDefaultTranslation

Up 
post /references({id})/defaultTranslations
Create new navigation property to defaultTranslations for references (references.CreateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
delete /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property defaultTranslations for references (references.DeleteDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Get defaultTranslations from references (references.GetDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.defaultTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "reference" : {
    "@odata.type" : "Microsoft.NAV.reference"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.defaultTranslation

default

error odata.error
Up 
get /references({id})/defaultTranslations
Get defaultTranslations from references (references.ListDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of defaultTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "reference" : {
      "@odata.type" : "Microsoft.NAV.reference"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of defaultTranslation

default

error odata.error
Up 
patch /references({id})/defaultTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property defaultTranslations in references (references.UpdateDefaultTranslations)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of defaultTranslation format: uuid
lang (required)
Path Parameter — key: lang of defaultTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.defaultTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ReferencesItem

Up 
delete /references({id})/item
Delete navigation property item for references (references.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /references({id})/item
Get item from references (references.GetItem)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /references({id})/item/mainPictureSource
Get media content for the navigation property item from references (references.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /references({id})/item
Update the navigation property item in references (references.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ReferencesReference

Up 
post /references
Add new entity to references (references.reference.CreateReference)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.reference (required)
Body Parameter — New entity

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.reference

default

error odata.error
Up 
get /references({id})
Get entity from references by key (references.reference.GetReference)

Path parameters

id (required)
Path Parameter — key: id of reference format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.reference

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "referenceType" : "string",
  "lineType" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "order" : "integer",
  "dataId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.reference

default

error odata.error
Up 
get /references
Get entities from references (references.reference.ListReference)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of reference

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "referenceType" : "string",
    "lineType" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "order" : "integer",
    "dataId" : "string",
    "templateCode" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "defaultTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.defaultTranslation"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of reference

default

error odata.error

SubscriptionsSubscriptions

Up 
post /subscriptions
Add new entity to subscriptions (subscriptions.subscriptions.CreateSubscriptions)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.subscriptions (required)
Body Parameter — New entity

Return type

Microsoft.NAV.subscriptions

Example data

Content-Type: application/json
{
  "subscriptionId" : "string (identifier)",
  "notificationUrl" : "string",
  "resource" : "string",
  "timestamp" : "integer",
  "userId" : "string",
  "lastModifiedDateTime" : "string (timestamp)",
  "clientState" : "string",
  "expirationDateTime" : "string (timestamp)",
  "systemCreatedAt" : "string (timestamp)",
  "systemCreatedBy" : "string",
  "systemModifiedAt" : "string (timestamp)",
  "systemModifiedBy" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.subscriptions

default

error odata.error
Up 
delete /subscriptions({subscriptionId})
Delete entity from subscriptions (subscriptions.subscriptions.DeleteSubscriptions)

Path parameters

subscriptionId (required)
Path Parameter — key: subscriptionId of subscriptions

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /subscriptions({subscriptionId})
Get entity from subscriptions by key (subscriptions.subscriptions.GetSubscriptions)

Path parameters

subscriptionId (required)
Path Parameter — key: subscriptionId of subscriptions

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.subscriptions

Example data

Content-Type: application/json
{
  "subscriptionId" : "string (identifier)",
  "notificationUrl" : "string",
  "resource" : "string",
  "timestamp" : "integer",
  "userId" : "string",
  "lastModifiedDateTime" : "string (timestamp)",
  "clientState" : "string",
  "expirationDateTime" : "string (timestamp)",
  "systemCreatedAt" : "string (timestamp)",
  "systemCreatedBy" : "string",
  "systemModifiedAt" : "string (timestamp)",
  "systemModifiedBy" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.subscriptions

default

error odata.error
Up 
get /subscriptions
Get entities from subscriptions (subscriptions.subscriptions.ListSubscriptions)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of subscriptions

Example data

Content-Type: application/json
{
  "value" : [ {
    "subscriptionId" : "string (identifier)",
    "notificationUrl" : "string",
    "resource" : "string",
    "timestamp" : "integer",
    "userId" : "string",
    "lastModifiedDateTime" : "string (timestamp)",
    "clientState" : "string",
    "expirationDateTime" : "string (timestamp)",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string"
  }, {
    "subscriptionId" : "string (identifier)",
    "notificationUrl" : "string",
    "resource" : "string",
    "timestamp" : "integer",
    "userId" : "string",
    "lastModifiedDateTime" : "string (timestamp)",
    "clientState" : "string",
    "expirationDateTime" : "string (timestamp)",
    "systemCreatedAt" : "string (timestamp)",
    "systemCreatedBy" : "string",
    "systemModifiedAt" : "string (timestamp)",
    "systemModifiedBy" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of subscriptions

default

error odata.error
Up 
patch /subscriptions({subscriptionId})
Update entity in subscriptions (subscriptions.subscriptions.UpdateSubscriptions)

Path parameters

subscriptionId (required)
Path Parameter — key: subscriptionId of subscriptions

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.subscriptions (required)
Body Parameter — New property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

TextTranslationsText

Up 
delete /textTranslations(lineGuid={lineGuid},lang={lang})/text
Delete navigation property text for textTranslations (textTranslations.DeleteText)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /textTranslations(lineGuid={lineGuid},lang={lang})/text
Get text from textTranslations (textTranslations.GetText)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.text

default

error odata.error
Up 
get /textTranslations(lineGuid={lineGuid},lang={lang})/text/source
Get media content for the navigation property text from textTranslations (textTranslations.GetTextSource)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /textTranslations(lineGuid={lineGuid},lang={lang})/text
Update the navigation property text in textTranslations (textTranslations.UpdateText)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

TextTranslationsTextTranslation

Up 
post /textTranslations
Add new entity to textTranslations (textTranslations.textTranslation.CreateTextTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.textTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.textTranslation

default

error odata.error
Up 
get /textTranslations(lineGuid={lineGuid},lang={lang})
Get entity from textTranslations by key (textTranslations.textTranslation.GetTextTranslation)

Path parameters

lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.textTranslation

default

error odata.error
Up 
get /textTranslations
Get entities from textTranslations (textTranslations.textTranslation.ListTextTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of textTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of textTranslation

default

error odata.error

TextsCategory

Up 
delete /texts({id})/category
Delete navigation property category for texts (texts.DeleteCategory)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /texts({id})/category
Get category from texts (texts.GetCategory)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.category

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "type" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "parentId" : "string",
  "categoryId" : "string",
  "sisterLineId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "items" : [ {
    "@odata.type" : "Microsoft.NAV.item"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.category

default

error odata.error
Up 
get /texts({id})/category/mainPictureSource
Get media content for the navigation property category from texts (texts.GetCategoryMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /texts({id})/category
Update the navigation property category in texts (texts.UpdateCategory)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.category (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

TextsDocument

Up 
delete /texts({id})/document
Delete navigation property document for texts (texts.DeleteDocument)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /texts({id})/document
Get document from texts (texts.GetDocument)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
patch /texts({id})/document
Update the navigation property document in texts (texts.UpdateDocument)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

TextsItem

Up 
delete /texts({id})/item
Delete navigation property item for texts (texts.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /texts({id})/item
Get item from texts (texts.GetItem)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /texts({id})/item/mainPictureSource
Get media content for the navigation property item from texts (texts.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /texts({id})/item
Update the navigation property item in texts (texts.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

TextsText

Up 
post /texts
Add new entity to texts (texts.text.CreateText)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.text (required)
Body Parameter — New entity

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.text

default

error odata.error
Up 
get /texts({id})/source
Get media content for text from texts (texts.text.GetSource)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
get /texts({id})
Get entity from texts by key (texts.text.GetText)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.text

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "class" : "string",
  "source" : "string",
  "text" : "string",
  "element" : "string",
  "description" : "string",
  "description2" : "string",
  "dataId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "textTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.textTranslation"
  } ],
  "document" : {
    "@odata.type" : "Microsoft.NAV.document"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.text

default

error odata.error
Up 
get /texts
Get entities from texts (texts.text.ListText)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of text

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "class" : "string",
    "source" : "string",
    "text" : "string",
    "element" : "string",
    "description" : "string",
    "description2" : "string",
    "dataId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "textTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.textTranslation"
    } ],
    "document" : {
      "@odata.type" : "Microsoft.NAV.document"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of text

default

error odata.error

TextsTextTranslation

Up 
post /texts({id})/textTranslations
Create new navigation property to textTranslations for texts (texts.CreateTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.textTranslation (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.textTranslation

default

error odata.error
Up 
delete /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Delete navigation property textTranslations for texts (texts.DeleteTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Get textTranslations from texts (texts.GetTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.textTranslation

Example data

Content-Type: application/json
{
  "lineGuid" : "string (identifier)",
  "lang" : "string (identifier)",
  "description" : "string",
  "description2" : "string",
  "html" : "string",
  "text" : {
    "@odata.type" : "Microsoft.NAV.text"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.textTranslation

default

error odata.error
Up 
get /texts({id})/textTranslations
Get textTranslations from texts (texts.ListTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of textTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  }, {
    "lineGuid" : "string (identifier)",
    "lang" : "string (identifier)",
    "description" : "string",
    "description2" : "string",
    "html" : "string",
    "text" : {
      "@odata.type" : "Microsoft.NAV.text"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of textTranslation

default

error odata.error
Up 
patch /texts({id})/textTranslations(lineGuid={lineGuid},lang={lang})
Update the navigation property textTranslations in texts (texts.UpdateTextTranslations)

Path parameters

id (required)
Path Parameter — key: id of text format: uuid
lineGuid (required)
Path Parameter — key: lineGuid of textTranslation format: uuid
lang (required)
Path Parameter — key: lang of textTranslation

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.textTranslation (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

ValueTranslationsValueTranslation

Up 
post /valueTranslations
Add new entity to valueTranslations (valueTranslations.valueTranslation.CreateValueTranslation)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.valueTranslation (required)
Body Parameter — New entity

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.valueTranslation

default

error odata.error
Up 
get /valueTranslations(type={type},code={code},variantCode={variantCode},lineNo={lineNo},no={no},lang={lang})
Get entity from valueTranslations by key (valueTranslations.valueTranslation.GetValueTranslation)

Path parameters

type (required)
Path Parameter — key: type of valueTranslation
code (required)
Path Parameter — key: code of valueTranslation
variantCode (required)
Path Parameter — key: variantCode of valueTranslation
lineNo (required)
Path Parameter — key: lineNo of valueTranslation format: int32
no (required)
Path Parameter — key: no of valueTranslation format: int32
lang (required)
Path Parameter — key: lang of valueTranslation

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.valueTranslation

Example data

Content-Type: application/json
{
  "type" : "string (identifier)",
  "code" : "string (identifier)",
  "variantCode" : "string (identifier)",
  "lineNo" : "integer (identifier)",
  "no" : "integer (identifier)",
  "lang" : "string (identifier)",
  "description" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.valueTranslation

default

error odata.error
Up 
get /valueTranslations
Get entities from valueTranslations (valueTranslations.valueTranslation.ListValueTranslation)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of valueTranslation

Example data

Content-Type: application/json
{
  "value" : [ {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  }, {
    "type" : "string (identifier)",
    "code" : "string (identifier)",
    "variantCode" : "string (identifier)",
    "lineNo" : "integer (identifier)",
    "no" : "integer (identifier)",
    "lang" : "string (identifier)",
    "description" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of valueTranslation

default

error odata.error

VariantsDocument

Up 
post /variants({id})/documents
Create new navigation property to documents for variants (variants.CreateDocuments)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.document

default

error odata.error
Up 
delete /variants({id})/documents({id1})
Delete navigation property documents for variants (variants.DeleteDocuments)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /variants({id})/documents({id1})
Get documents from variants (variants.GetDocuments)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.document

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "group" : "string",
  "type" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "link" : "string",
  "sourceFileName" : "string",
  "mimeType" : "string",
  "templateCode" : "string",
  "order" : "integer",
  "documentUsage" : "string",
  "dataId" : "string",
  "repositoryType" : {
    "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
  },
  "externalContainerId" : "string",
  "externalId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "sorting" : "integer",
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "documentTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.documentTranslation"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "variant" : {
    "@odata.type" : "Microsoft.NAV.variant"
  }
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.document

default

error odata.error
Up 
get /variants({id})/documents
Get documents from variants (variants.ListDocuments)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of document

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "group" : "string",
    "type" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "link" : "string",
    "sourceFileName" : "string",
    "mimeType" : "string",
    "templateCode" : "string",
    "order" : "integer",
    "documentUsage" : "string",
    "dataId" : "string",
    "repositoryType" : {
      "@odata.type" : "Microsoft.NAV.pimxDocumentRepositoryType"
    },
    "externalContainerId" : "string",
    "externalId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "sorting" : "integer",
    "category" : {
      "@odata.type" : "Microsoft.NAV.category"
    },
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ],
    "documentTranslations" : [ {
      "@odata.type" : "Microsoft.NAV.documentTranslation"
    } ],
    "texts" : [ {
      "@odata.type" : "Microsoft.NAV.text"
    } ],
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "variant" : {
      "@odata.type" : "Microsoft.NAV.variant"
    }
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of document

default

error odata.error
Up 
patch /variants({id})/documents({id1})
Update the navigation property documents in variants (variants.UpdateDocuments)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of document format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.document (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

VariantsDocumentSource

Up 
post /variants({id})/documentsSources
Create new navigation property to documentsSources for variants (variants.CreateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created navigation property. Microsoft.NAV.documentSource

default

error odata.error
Up 
delete /variants({id})/documentsSources({id1})
Delete navigation property documentsSources for variants (variants.DeleteDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /variants({id})/documentsSources({id1})
Get documentsSources from variants (variants.GetDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.documentSource

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "code" : "string",
  "source" : "string"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.documentSource

default

error odata.error
Up 
get /variants({id})/documentsSources
Get documentsSources from variants (variants.ListDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of documentSource

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  }, {
    "id" : "string (identifier)",
    "code" : "string",
    "source" : "string"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Collection of documentSource

default

error odata.error
Up 
patch /variants({id})/documentsSources({id1})
Update the navigation property documentsSources in variants (variants.UpdateDocumentsSources)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid
id1 (required)
Path Parameter — key: id of documentSource format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.documentSource (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

VariantsItem

Up 
delete /variants({id})/item
Delete navigation property item for variants (variants.DeleteItem)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Request headers

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error
Up 
get /variants({id})/item
Get item from variants (variants.GetItem)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.item

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "sisterLineId" : "string",
  "itemId" : "string",
  "type" : "string",
  "publicationCode" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "mainPictureSource" : "string",
  "element" : "string",
  "categoryId" : "string",
  "templateCode" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "category" : {
    "@odata.type" : "Microsoft.NAV.category"
  },
  "features" : [ {
    "@odata.type" : "Microsoft.NAV.feature"
  } ],
  "texts" : [ {
    "@odata.type" : "Microsoft.NAV.text"
  } ],
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ],
  "references" : [ {
    "@odata.type" : "Microsoft.NAV.reference"
  } ],
  "keywords" : [ {
    "@odata.type" : "Microsoft.NAV.keyword"
  } ],
  "defaultTranslations" : [ {
    "@odata.type" : "Microsoft.NAV.defaultTranslation"
  } ],
  "contents" : [ {
    "@odata.type" : "Microsoft.NAV.content"
  } ],
  "htmlContents" : [ {
    "@odata.type" : "Microsoft.NAV.htmlContent"
  } ],
  "variants" : [ {
    "@odata.type" : "Microsoft.NAV.variant"
  } ],
  "prices" : [ {
    "@odata.type" : "Microsoft.NAV.price"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved navigation property Microsoft.NAV.item

default

error odata.error
Up 
get /variants({id})/item/mainPictureSource
Get media content for the navigation property item from variants (variants.GetItemMainPictureSource)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Return type

byte[]

Example data

Content-Type: application/json
""

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved media content byte[]

default

error odata.error
Up 
patch /variants({id})/item
Update the navigation property item in variants (variants.UpdateItem)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.item (required)
Body Parameter — New navigation property values

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

204

Success

default

error odata.error

VariantsVariant

Up 
post /variants
Add new entity to variants (variants.variant.CreateVariant)

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body Microsoft.NAV.variant (required)
Body Parameter — New entity

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

201

Created entity Microsoft.NAV.variant

default

error odata.error
Up 
get /variants({id})
Get entity from variants by key (variants.variant.GetVariant)

Path parameters

id (required)
Path Parameter — key: id of variant format: uuid

Query parameters

$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Microsoft.NAV.variant

Example data

Content-Type: application/json
{
  "id" : "string (identifier)",
  "parentEntityId" : "string",
  "dataId" : "string",
  "publicationCode" : "string",
  "group" : "string",
  "number" : "string",
  "description" : "string",
  "description2" : "string",
  "mainPictureId" : "string",
  "state" : {
    "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
  },
  "item" : {
    "@odata.type" : "Microsoft.NAV.item"
  },
  "documents" : [ {
    "@odata.type" : "Microsoft.NAV.document"
  } ],
  "documentsSources" : [ {
    "@odata.type" : "Microsoft.NAV.documentSource"
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entity Microsoft.NAV.variant

default

error odata.error
Up 
get /variants
Get entities from variants (variants.variant.ListVariant)

Query parameters

$top (optional)
Query Parameter — Show only the first n items
$skip (optional)
Query Parameter — Skip the first n items
$search (optional)
Query Parameter — Search items by search phrases
$filter (optional)
Query Parameter — Filter items by property values
$count (optional)
Query Parameter — Include count of items
$orderby (optional)
Query Parameter — Order items by property values
$select (optional)
Query Parameter — Select properties to be returned
$expand (optional)
Query Parameter — Expand related entities

Return type

Collection of variant

Example data

Content-Type: application/json
{
  "value" : [ {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  }, {
    "id" : "string (identifier)",
    "parentEntityId" : "string",
    "dataId" : "string",
    "publicationCode" : "string",
    "group" : "string",
    "number" : "string",
    "description" : "string",
    "description2" : "string",
    "mainPictureId" : "string",
    "state" : {
      "@odata.type" : "Microsoft.NAV.pimxPublicationLineState"
    },
    "item" : {
      "@odata.type" : "Microsoft.NAV.item"
    },
    "documents" : [ {
      "@odata.type" : "Microsoft.NAV.document"
    } ],
    "documentsSources" : [ {
      "@odata.type" : "Microsoft.NAV.documentSource"
    } ]
  } ]
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Retrieved entities Collection of variant

default

error odata.error

Models

[ Jump to Methods ]

Table of Contents

  1. Collection of apicategoryroutes - Collection of apicategoryroutes
  2. Collection of category - Collection of category
  3. Collection of changedLine - Collection of changedLine
  4. Collection of company - Collection of company
  5. Collection of content - Collection of content
  6. Collection of defaultTranslation - Collection of defaultTranslation
  7. Collection of deletedLine - Collection of deletedLine
  8. Collection of document - Collection of document
  9. Collection of documentSource - Collection of documentSource
  10. Collection of documentTranslation - Collection of documentTranslation
  11. Collection of entityMetadata - Collection of entityMetadata
  12. Collection of externalbusinesseventdefinitions - Collection of externalbusinesseventdefinitions
  13. Collection of externaleventsubscriptions - Collection of externaleventsubscriptions
  14. Collection of feature - Collection of feature
  15. Collection of featureTranslation - Collection of featureTranslation
  16. Collection of featureValue - Collection of featureValue
  17. Collection of featureValueSet - Collection of featureValueSet
  18. Collection of htmlContent - Collection of htmlContent
  19. Collection of item - Collection of item
  20. Collection of keyword - Collection of keyword
  21. Collection of keywordTranslation - Collection of keywordTranslation
  22. Collection of price - Collection of price
  23. Collection of reference - Collection of reference
  24. Collection of subscriptions - Collection of subscriptions
  25. Collection of text - Collection of text
  26. Collection of textTranslation - Collection of textTranslation
  27. Collection of valueTranslation - Collection of valueTranslation
  28. Collection of variant - Collection of variant
  29. Microsoft.NAV.apicategoryroutes - apicategoryroutes
  30. Microsoft.NAV.category - category
  31. Microsoft.NAV.changedLine - changedLine
  32. Microsoft.NAV.company - company
  33. Microsoft.NAV.content - content
  34. Microsoft.NAV.defaultTranslation - defaultTranslation
  35. Microsoft.NAV.deletedLine - deletedLine
  36. Microsoft.NAV.document - document
  37. Microsoft.NAV.documentSource - documentSource
  38. Microsoft.NAV.documentTranslation - documentTranslation
  39. Microsoft.NAV.entityMetadata - entityMetadata
  40. Microsoft.NAV.entityMetadataAction - entityMetadataAction
  41. Microsoft.NAV.entityMetadataEnumMember - entityMetadataEnumMember
  42. Microsoft.NAV.entityMetadataField - entityMetadataField
  43. Microsoft.NAV.entityMetadataLabel - entityMetadataLabel
  44. Microsoft.NAV.externalbusinesseventdefinitions - externalbusinesseventdefinitions
  45. Microsoft.NAV.externaleventsubscriptions - externaleventsubscriptions
  46. Microsoft.NAV.feature - feature
  47. Microsoft.NAV.featureTranslation - featureTranslation
  48. Microsoft.NAV.featureValue - featureValue
  49. Microsoft.NAV.featureValueSet - featureValueSet
  50. Microsoft.NAV.htmlContent - htmlContent
  51. Microsoft.NAV.item - item
  52. Microsoft.NAV.keyword - keyword
  53. Microsoft.NAV.keywordTranslation - keywordTranslation
  54. Microsoft.NAV.pimxDocumentRepositoryType - pimxDocumentRepositoryType
  55. Microsoft.NAV.pimxFeatureType - pimxFeatureType
  56. Microsoft.NAV.pimxImportance - pimxImportance
  57. Microsoft.NAV.pimxPublicationLineState - pimxPublicationLineState
  58. Microsoft.NAV.pimxRelevance - pimxRelevance
  59. Microsoft.NAV.price - price
  60. Microsoft.NAV.reference - reference
  61. Microsoft.NAV.subscriptions - subscriptions
  62. Microsoft.NAV.text - text
  63. Microsoft.NAV.textTranslation - textTranslation
  64. Microsoft.NAV.valueTranslation - valueTranslation
  65. Microsoft.NAV.variant - variant
  66. odata.error
  67. odata.error.detail
  68. odata.error.main

Collection of apicategoryroutes - Collection of apicategoryroutes Up

value (optional)
array[Microsoft.NAV.apicategoryroutes]

Collection of category - Collection of category Up

value (optional)
array[Microsoft.NAV.category]

Collection of changedLine - Collection of changedLine Up

value (optional)
array[Microsoft.NAV.changedLine]

Collection of company - Collection of company Up

value (optional)
array[Microsoft.NAV.company]

Collection of content - Collection of content Up

value (optional)
array[Microsoft.NAV.content]

Collection of defaultTranslation - Collection of defaultTranslation Up

value (optional)
array[Microsoft.NAV.defaultTranslation]

Collection of deletedLine - Collection of deletedLine Up

value (optional)
array[Microsoft.NAV.deletedLine]

Collection of document - Collection of document Up

value (optional)
array[Microsoft.NAV.document]

Collection of documentSource - Collection of documentSource Up

value (optional)
array[Microsoft.NAV.documentSource]

Collection of documentTranslation - Collection of documentTranslation Up

value (optional)
array[Microsoft.NAV.documentTranslation]

Collection of entityMetadata - Collection of entityMetadata Up

value (optional)
array[Microsoft.NAV.entityMetadata]

Collection of externalbusinesseventdefinitions - Collection of externalbusinesseventdefinitions Up

value (optional)
array[Microsoft.NAV.externalbusinesseventdefinitions]

Collection of externaleventsubscriptions - Collection of externaleventsubscriptions Up

value (optional)
array[Microsoft.NAV.externaleventsubscriptions]

Collection of feature - Collection of feature Up

value (optional)
array[Microsoft.NAV.feature]

Collection of featureTranslation - Collection of featureTranslation Up

value (optional)
array[Microsoft.NAV.featureTranslation]

Collection of featureValue - Collection of featureValue Up

value (optional)
array[Microsoft.NAV.featureValue]

Collection of featureValueSet - Collection of featureValueSet Up

value (optional)
array[Microsoft.NAV.featureValueSet]

Collection of htmlContent - Collection of htmlContent Up

value (optional)
array[Microsoft.NAV.htmlContent]

Collection of item - Collection of item Up

value (optional)
array[Microsoft.NAV.item]

Collection of keyword - Collection of keyword Up

value (optional)
array[Microsoft.NAV.keyword]

Collection of keywordTranslation - Collection of keywordTranslation Up

value (optional)
array[Microsoft.NAV.keywordTranslation]

Collection of price - Collection of price Up

value (optional)
array[Microsoft.NAV.price]

Collection of reference - Collection of reference Up

value (optional)
array[Microsoft.NAV.reference]

Collection of subscriptions - Collection of subscriptions Up

value (optional)
array[Microsoft.NAV.subscriptions]

Collection of text - Collection of text Up

value (optional)
array[Microsoft.NAV.text]

Collection of textTranslation - Collection of textTranslation Up

value (optional)
array[Microsoft.NAV.textTranslation]

Collection of valueTranslation - Collection of valueTranslation Up

value (optional)
array[Microsoft.NAV.valueTranslation]

Collection of variant - Collection of variant Up

value (optional)
array[Microsoft.NAV.variant]

Microsoft.NAV.apicategoryroutes - apicategoryroutes Up

route (optional)
String
publisher (optional)
String
group (optional)
String
version (optional)
String

Microsoft.NAV.category - category Up

id (optional)
UUID format: uuid
publicationCode (optional)
String
number (optional)
String
description (optional)
String
description2 (optional)
String
type (optional)
String
mainPictureId (optional)
String
mainPictureSource (optional)
String format: base64url
element (optional)
String
parentId (optional)
UUID format: uuid
categoryId (optional)
UUID format: uuid
sisterLineId (optional)
UUID format: uuid
templateCode (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
features (optional)
array[Microsoft.NAV.feature]
texts (optional)
array[Microsoft.NAV.text]
documents (optional)
array[Microsoft.NAV.document]
documentsSources (optional)
array[Microsoft.NAV.documentSource]
items (optional)
array[Microsoft.NAV.item]
references (optional)
array[Microsoft.NAV.reference]
keywords (optional)
array[Microsoft.NAV.keyword]
defaultTranslations (optional)
array[Microsoft.NAV.defaultTranslation]
contents (optional)
array[Microsoft.NAV.content]

Microsoft.NAV.changedLine - changedLine Up

id (optional)
UUID format: uuid
lineId (optional)
UUID format: uuid
lineType (optional)
String
publicationCode (optional)
String
lineEntityUrl (optional)
String
parentLineId (optional)
UUID format: uuid
parentLineType (optional)
String
parentLineUrl (optional)
String
dateModified (optional)
Date format: date-time
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   

Microsoft.NAV.company - company Up

id (optional)
UUID format: uuid
systemVersion (optional)
String
timestamp (optional)
Long format: int64
name (optional)
String
displayName (optional)
String
businessProfileId (optional)
String
systemCreatedAt (optional)
Date format: date-time
systemCreatedBy (optional)
UUID format: uuid
systemModifiedAt (optional)
Date format: date-time
systemModifiedBy (optional)
UUID format: uuid
changedLines (optional)
array[Microsoft.NAV.changedLine]
deletedLines (optional)
array[Microsoft.NAV.deletedLine]
htmlContents (optional)
array[Microsoft.NAV.htmlContent]
featureValueSets (optional)
array[Microsoft.NAV.featureValueSet]
valueTranslations (optional)
array[Microsoft.NAV.valueTranslation]
prices (optional)
array[Microsoft.NAV.price]
categories (optional)
array[Microsoft.NAV.category]
features (optional)
array[Microsoft.NAV.feature]
featuresValues (optional)
array[Microsoft.NAV.featureValue]
featureTranslations (optional)
array[Microsoft.NAV.featureTranslation]
texts (optional)
array[Microsoft.NAV.text]
textTranslations (optional)
array[Microsoft.NAV.textTranslation]
documents (optional)
array[Microsoft.NAV.document]
documentsSources (optional)
array[Microsoft.NAV.documentSource]
documentTranslations (optional)
array[Microsoft.NAV.documentTranslation]
items (optional)
array[Microsoft.NAV.item]
references (optional)
array[Microsoft.NAV.reference]
defaultTranslations (optional)
array[Microsoft.NAV.defaultTranslation]
keywords (optional)
array[Microsoft.NAV.keyword]
keywordTranslations (optional)
array[Microsoft.NAV.keywordTranslation]
contents (optional)
array[Microsoft.NAV.content]
variants (optional)
array[Microsoft.NAV.variant]

Microsoft.NAV.content - content Up

id (optional)
UUID format: uuid
publicationCode (optional)
String
lineId (optional)
UUID format: uuid
lineType (optional)
String
lineEntityUrl (optional)
String
parentLineId (optional)
UUID format: uuid
parentLineType (optional)
String
parentEntityUrl (optional)
String
templateCode (optional)
String
level (optional)
Integer format: int32
lineNo (optional)
Integer format: int32
dataId (optional)
UUID format: uuid
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
category (optional)
anyOf: Microsoft.NAV.category   
item (optional)
anyOf: Microsoft.NAV.item   

Microsoft.NAV.defaultTranslation - defaultTranslation Up

lineGuid (optional)
UUID format: uuid
lang (optional)
String
description (optional)
String
description2 (optional)
String
category (optional)
anyOf: Microsoft.NAV.category   
item (optional)
anyOf: Microsoft.NAV.item   
reference (optional)
anyOf: Microsoft.NAV.reference   

Microsoft.NAV.deletedLine - deletedLine Up

logId (optional)
UUID format: uuid
id (optional)
UUID format: uuid
lineId (optional)
UUID format: uuid
lineType (optional)
String
publicationCode (optional)
String
lineEntityUrl (optional)
String
parentLineId (optional)
UUID format: uuid
parentLineType (optional)
String
parentLineUrl (optional)
String
dateModified (optional)
Date format: date-time

Microsoft.NAV.document - document Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
group (optional)
String
type (optional)
String
number (optional)
String
description (optional)
String
description2 (optional)
String
link (optional)
String
sourceFileName (optional)
String
mimeType (optional)
String
templateCode (optional)
String
order (optional)
Integer format: int32
documentUsage (optional)
String
dataId (optional)
UUID format: uuid
repositoryType (optional)
anyOf: Microsoft.NAV.pimxDocumentRepositoryType   
externalContainerId (optional)
String
externalId (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
sorting (optional)
Integer format: int32
category (optional)
anyOf: Microsoft.NAV.category   
documentsSources (optional)
array[Microsoft.NAV.documentSource]
documentTranslations (optional)
array[Microsoft.NAV.documentTranslation]
texts (optional)
array[Microsoft.NAV.text]
item (optional)
anyOf: Microsoft.NAV.item   
variant (optional)
anyOf: Microsoft.NAV.variant   

Microsoft.NAV.documentSource - documentSource Up

id (optional)
UUID format: uuid
code (optional)
String
source (optional)
String

Microsoft.NAV.documentTranslation - documentTranslation Up

lineGuid (optional)
UUID format: uuid
lang (optional)
String
description (optional)
String
description2 (optional)
String
document (optional)
anyOf: Microsoft.NAV.document   

Microsoft.NAV.entityMetadata - entityMetadata Up

entityName (optional)
String
entitySetName (optional)
String
entityCaptions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataLabel   
entitySetCaptions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataLabel   
properties (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataField   
actions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataAction   
enumMembers (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataEnumMember   

Microsoft.NAV.entityMetadataAction - entityMetadataAction Up

name (optional)
String
captions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataLabel   

Microsoft.NAV.entityMetadataEnumMember - entityMetadataEnumMember Up

name (optional)
String
value (optional)
Integer format: int32
captions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataLabel   

Microsoft.NAV.entityMetadataField - entityMetadataField Up

name (optional)
String
captions (optional)
array[null]
items anyOf: Microsoft.NAV.entityMetadataLabel   

Microsoft.NAV.entityMetadataLabel - entityMetadataLabel Up

languageCode (optional)
Integer format: int32
caption (optional)
String

Microsoft.NAV.externalbusinesseventdefinitions - externalbusinesseventdefinitions Up

appId (optional)
UUID format: uuid
name (optional)
String
eventVersion (optional)
String
isObsolete (optional)
Boolean
obsoleteReason (optional)
String
obsoleteTag (optional)
String
payload (optional)
String
displayName (optional)
String
description (optional)
String
category (optional)
String
appName (optional)
String
appPublisher (optional)
String
appVersion (optional)
String

Microsoft.NAV.externaleventsubscriptions - externaleventsubscriptions Up

id (optional)
UUID format: uuid
companyId (optional)
UUID format: uuid
timestamp (optional)
Long format: int64
appId (optional)
UUID format: uuid
eventName (optional)
String
companyName (optional)
String
userId (optional)
UUID format: uuid
notificationUrl (optional)
String
lastModifiedDateTime (optional)
Date format: date-time
clientState (optional)
String
subscriptionType (optional)
String
eventVersion (optional)
String
subscriptionState (optional)
String
systemCreatedAt (optional)
Date format: date-time
systemCreatedBy (optional)
UUID format: uuid
systemModifiedAt (optional)
Date format: date-time
systemModifiedBy (optional)
UUID format: uuid

Microsoft.NAV.feature - feature Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
group (optional)
String
number (optional)
String
lineType (optional)
String
description (optional)
String
valueId (optional)
String
value (optional)
String
textValue (optional)
String
fromValue (optional)
BigDecimal format: decimal
toValue (optional)
BigDecimal format: decimal
unitCode (optional)
String
unit (optional)
String
unitShorthand (optional)
String
classification (optional)
String
type (optional)
String
order (optional)
Integer format: int32
polyvalent (optional)
Boolean
featureType (optional)
anyOf: Microsoft.NAV.pimxFeatureType   
parentItemNo (optional)
String
dataId (optional)
UUID format: uuid
valueSearchDescription (optional)
String
importance (optional)
anyOf: Microsoft.NAV.pimxImportance   
relevance (optional)
anyOf: Microsoft.NAV.pimxRelevance   
valueSetId (optional)
Long format: int64
sorting (optional)
Integer format: int32
element (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
usageTypeCode (optional)
String
category (optional)
anyOf: Microsoft.NAV.category   
featuresValues (optional)
array[Microsoft.NAV.featureValue]
featureValueSets (optional)
array[Microsoft.NAV.featureValueSet]
featureTranslations (optional)
array[Microsoft.NAV.featureTranslation]
item (optional)
anyOf: Microsoft.NAV.item   

Microsoft.NAV.featureTranslation - featureTranslation Up

lineGuid (optional)
UUID format: uuid
lang (optional)
String
description (optional)
String
value (optional)
String
unitShorthand (optional)
String
unitDescription (optional)
String
feature (optional)
anyOf: Microsoft.NAV.feature   

Microsoft.NAV.featureValue - featureValue Up

id (optional)
UUID format: uuid
entityType (optional)
String
entityNo (optional)
String
featureNo (optional)
String
number (optional)
String
value (optional)
String
valueTranslations (optional)
array[Microsoft.NAV.valueTranslation]

Microsoft.NAV.featureValueSet - featureValueSet Up

id (optional)
UUID format: uuid
featureId (optional)
String
valueId (optional)
String
value (optional)
String
valueTranslations (optional)
array[Microsoft.NAV.valueTranslation]

Microsoft.NAV.htmlContent - htmlContent Up

id (optional)
UUID format: uuid
publicationCode (optional)
String
data (optional)
String
status (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   

Microsoft.NAV.item - item Up

id (optional)
UUID format: uuid
sisterLineId (optional)
UUID format: uuid
itemId (optional)
UUID format: uuid
type (optional)
String
publicationCode (optional)
String
number (optional)
String
description (optional)
String
description2 (optional)
String
mainPictureId (optional)
String
mainPictureSource (optional)
String format: base64url
element (optional)
String
categoryId (optional)
UUID format: uuid
templateCode (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
category (optional)
anyOf: Microsoft.NAV.category   
features (optional)
array[Microsoft.NAV.feature]
texts (optional)
array[Microsoft.NAV.text]
documents (optional)
array[Microsoft.NAV.document]
documentsSources (optional)
array[Microsoft.NAV.documentSource]
references (optional)
array[Microsoft.NAV.reference]
keywords (optional)
array[Microsoft.NAV.keyword]
defaultTranslations (optional)
array[Microsoft.NAV.defaultTranslation]
contents (optional)
array[Microsoft.NAV.content]
htmlContents (optional)
array[Microsoft.NAV.htmlContent]
variants (optional)
array[Microsoft.NAV.variant]
prices (optional)
array[Microsoft.NAV.price]

Microsoft.NAV.keyword - keyword Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
group (optional)
String
number (optional)
String
description (optional)
String
order (optional)
Integer format: int32
dataId (optional)
UUID format: uuid
templateCode (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
category (optional)
anyOf: Microsoft.NAV.category   
item (optional)
anyOf: Microsoft.NAV.item   
keywordTranslations (optional)
array[Microsoft.NAV.keywordTranslation]

Microsoft.NAV.keywordTranslation - keywordTranslation Up

lineGuid (optional)
UUID format: uuid
lang (optional)
String
description (optional)
String
keyword (optional)
anyOf: Microsoft.NAV.keyword   

Microsoft.NAV.pimxDocumentRepositoryType - pimxDocumentRepositoryType Up

Microsoft.NAV.pimxFeatureType - pimxFeatureType Up

Microsoft.NAV.pimxImportance - pimxImportance Up

Microsoft.NAV.pimxPublicationLineState - pimxPublicationLineState Up

Microsoft.NAV.pimxRelevance - pimxRelevance Up

Microsoft.NAV.price - price Up

id (optional)
UUID format: uuid
publicationLineId (optional)
UUID format: uuid
code (optional)
String
unitOfMeasure (optional)
String
minimumQuantity (optional)
BigDecimal format: decimal
currencyCode (optional)
String
itemNo (optional)
String
price (optional)
BigDecimal format: decimal
vat (optional)
BigDecimal format: decimal
priceInclVAT (optional)
BigDecimal format: decimal
startingDate (optional)
date format: date
endingDate (optional)
date format: date
updatedOn (optional)
Date format: date-time
updatedBy (optional)
String
item (optional)
anyOf: Microsoft.NAV.item   

Microsoft.NAV.reference - reference Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
group (optional)
String
referenceType (optional)
String
lineType (optional)
String
number (optional)
String
description (optional)
String
description2 (optional)
String
order (optional)
Integer format: int32
dataId (optional)
UUID format: uuid
templateCode (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
category (optional)
anyOf: Microsoft.NAV.category   
item (optional)
anyOf: Microsoft.NAV.item   
defaultTranslations (optional)
array[Microsoft.NAV.defaultTranslation]

Microsoft.NAV.subscriptions - subscriptions Up

subscriptionId (optional)
String
notificationUrl (optional)
String
resource (optional)
String
timestamp (optional)
Long format: int64
userId (optional)
UUID format: uuid
lastModifiedDateTime (optional)
Date format: date-time
clientState (optional)
String
expirationDateTime (optional)
Date format: date-time
systemCreatedAt (optional)
Date format: date-time
systemCreatedBy (optional)
UUID format: uuid
systemModifiedAt (optional)
Date format: date-time
systemModifiedBy (optional)
UUID format: uuid

Microsoft.NAV.text - text Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
group (optional)
String
class (optional)
String
source (optional)
String format: base64url
text (optional)
String
element (optional)
String
description (optional)
String
description2 (optional)
String
dataId (optional)
UUID format: uuid
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
category (optional)
anyOf: Microsoft.NAV.category   
textTranslations (optional)
array[Microsoft.NAV.textTranslation]
document (optional)
anyOf: Microsoft.NAV.document   
item (optional)
anyOf: Microsoft.NAV.item   

Microsoft.NAV.textTranslation - textTranslation Up

lineGuid (optional)
UUID format: uuid
lang (optional)
String
description (optional)
String
description2 (optional)
String
html (optional)
String
text (optional)
anyOf: Microsoft.NAV.text   

Microsoft.NAV.valueTranslation - valueTranslation Up

type (optional)
String
code (optional)
String
variantCode (optional)
String
lineNo (optional)
Integer format: int32
no (optional)
Integer format: int32
lang (optional)
String
description (optional)
String

Microsoft.NAV.variant - variant Up

id (optional)
UUID format: uuid
parentEntityId (optional)
UUID format: uuid
dataId (optional)
UUID format: uuid
publicationCode (optional)
String
group (optional)
String
number (optional)
String
description (optional)
String
description2 (optional)
String
mainPictureId (optional)
String
state (optional)
anyOf: Microsoft.NAV.pimxPublicationLineState   
item (optional)
anyOf: Microsoft.NAV.item   
documents (optional)
array[Microsoft.NAV.document]
documentsSources (optional)
array[Microsoft.NAV.documentSource]

odata.error Up

error
odata.error.main

odata.error.detail Up

code
String
message
String
target (optional)
String

odata.error.main Up

code
String
message
String
target (optional)
String
details (optional)
array[odata.error.detail]
innererror (optional)
Object The structure of this object is service-specific