@itentialopensource/adapter-microsoft_dynamics
Version:
This adapter integrates with system described as: Microsoft Dynamics 365: Business Applications
1,731 lines • 756 kB
YAML
openapi: 3.0.0
info:
title: (v1.0) Dynamics 365 Business Central
description: (v1.0) Business Central Standard APIs
contact: {}
version: '1.0.0'
servers:
- url: https://api.businesscentral.dynamics.com/v2.0/sandbox/api/v1.0
description: (v1.0) "Sandbox"
variables: {}
- url: https://login.windows.net/common/oauth2/authorize?resource=https://api.businesscentral.dynamics.com
description: (v1.0) "Sandbox"
variables: {}
- url: https://api.businesscentral.dynamics.com/v2.0/production/api/v1.0
description: (v1.0) "Production"
variables: {}
- url: https://login.windows.net/common/oauth2/authorize?resource=https://api.businesscentral.dynamics.com
description: (v1.0) "Production"
variables: {}
paths:
/companies:
get:
tags:
- company
summary: listCompanies
description: Returns a list of companies
operationId: listCompanies
parameters:
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select'
responses:
'200':
description: (v1.0) Succesfully returned a list of companies
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesResponse'
deprecated: false
/companies({company_id}):
get:
tags:
- company
summary: getCompany
description: Retrieve the properties and relationships of an object of type company for Dynamics 365 Business Central.
operationId: getCompany
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select'
responses:
'200':
description: (v1.0) Succesfully returned the requested company
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/company'
deprecated: false
/companies({company_id})/items:
get:
tags:
- item
summary: listItems
description: Returns a list of items
operationId: listItems
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $expand
in: query
description: (v1.0) Entities to expand
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/expand'
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select2'
responses:
'200':
description: (v1.0) Succesfully returned a list of items
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIItemsResponse'
deprecated: false
post:
tags:
- item
summary: postItem
description: Creates an object of type item in Dynamics 365 Business Central
operationId: postItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/item1'
required: true
responses:
'201':
description: (v1.0) A new item has been succesfully created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/item'
deprecated: false
/companies({company_id})/items({item_id}):
get:
tags:
- item
summary: getItem
description: Retrieve the properties and relationships of an object of type item for Dynamics 365 Business Central.
operationId: getItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: $expand
in: query
description: (v1.0) Entities to expand
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/expand'
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select2'
responses:
'200':
description: (v1.0) Succesfully returned the requested item
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/item'
deprecated: false
delete:
tags:
- item
summary: deleteItem
description: Deletes an object of type item in Dynamics 365 Business Central
operationId: deleteItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified item
headers: {}
content: {}
deprecated: false
patch:
tags:
- item
summary: patchItem
description: Updates an object of type item in Dynamics 365 Business Central
operationId: patchItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/item1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifieditem
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/item'
deprecated: false
/companies({company_id})/items({item_id})/picture:
get:
tags:
- picture
summary: listPictureForItem
description: Returns a list of picture
operationId: listPictureForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned a list of picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIItemsAPIPictureResponse'
deprecated: false
/companies({company_id})/items({item_id})/picture({picture_id}):
get:
tags:
- picture
summary: getPictureForItem
description: Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
operationId: getPictureForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned the requested picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
delete:
tags:
- picture
summary: deletePictureForItem
description: Deletes an object of type picture in Dynamics 365 Business Central
operationId: deletePictureForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified picture
headers: {}
content: {}
deprecated: false
patch:
tags:
- picture
summary: patchPictureForItem
description: Updates an object of type picture in Dynamics 365 Business Central
operationId: patchPictureForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/picture1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifiedpicture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
/companies({company_id})/picture:
get:
tags:
- picture
summary: listPicture
description: Returns a list of picture
operationId: listPicture
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned a list of picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIPictureResponse'
deprecated: false
/companies({company_id})/picture({picture_id}):
get:
tags:
- picture
summary: getPicture
description: Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
operationId: getPicture
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned the requested picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
delete:
tags:
- picture
summary: deletePicture
description: Deletes an object of type picture in Dynamics 365 Business Central
operationId: deletePicture
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified picture
headers: {}
content: {}
deprecated: false
patch:
tags:
- picture
summary: patchPicture
description: Updates an object of type picture in Dynamics 365 Business Central
operationId: patchPicture
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/picture1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifiedpicture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
/companies({company_id})/customers({customer_id})/picture:
get:
tags:
- picture
summary: listPictureForCustomer
description: Returns a list of picture
operationId: listPictureForCustomer
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: customer_id
in: path
description: (v1.0) id for customer
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned a list of picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPICustomersAPIPictureResponse'
deprecated: false
/companies({company_id})/customers({customer_id})/picture({picture_id}):
get:
tags:
- picture
summary: getPictureForCustomer
description: Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
operationId: getPictureForCustomer
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: customer_id
in: path
description: (v1.0) id for customer
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned the requested picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
delete:
tags:
- picture
summary: deletePictureForCustomer
description: Deletes an object of type picture in Dynamics 365 Business Central
operationId: deletePictureForCustomer
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: customer_id
in: path
description: (v1.0) id for customer
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified picture
headers: {}
content: {}
deprecated: false
patch:
tags:
- picture
summary: patchPictureForCustomer
description: Updates an object of type picture in Dynamics 365 Business Central
operationId: patchPictureForCustomer
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: customer_id
in: path
description: (v1.0) id for customer
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/picture1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifiedpicture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
/companies({company_id})/vendors({vendor_id})/picture:
get:
tags:
- picture
summary: listPictureForVendor
description: Returns a list of picture
operationId: listPictureForVendor
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: vendor_id
in: path
description: (v1.0) id for vendor
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned a list of picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIVendorsAPIPictureResponse'
deprecated: false
/companies({company_id})/vendors({vendor_id})/picture({picture_id}):
get:
tags:
- picture
summary: getPictureForVendor
description: Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
operationId: getPictureForVendor
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: vendor_id
in: path
description: (v1.0) id for vendor
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned the requested picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
delete:
tags:
- picture
summary: deletePictureForVendor
description: Deletes an object of type picture in Dynamics 365 Business Central
operationId: deletePictureForVendor
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: vendor_id
in: path
description: (v1.0) id for vendor
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified picture
headers: {}
content: {}
deprecated: false
patch:
tags:
- picture
summary: patchPictureForVendor
description: Updates an object of type picture in Dynamics 365 Business Central
operationId: patchPictureForVendor
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: vendor_id
in: path
description: (v1.0) id for vendor
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/picture1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifiedpicture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
/companies({company_id})/employees({employee_id})/picture:
get:
tags:
- picture
summary: listPictureForEmployee
description: Returns a list of picture
operationId: listPictureForEmployee
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: employee_id
in: path
description: (v1.0) id for employee
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned a list of picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIEmployeesAPIPictureResponse'
deprecated: false
/companies({company_id})/employees({employee_id})/picture({picture_id}):
get:
tags:
- picture
summary: getPictureForEmployee
description: Retrieve the properties and relationships of an object of type picture for Dynamics 365 Business Central.
operationId: getPictureForEmployee
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: employee_id
in: path
description: (v1.0) id for employee
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select4'
responses:
'200':
description: (v1.0) Succesfully returned the requested picture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
delete:
tags:
- picture
summary: deletePictureForEmployee
description: Deletes an object of type picture in Dynamics 365 Business Central
operationId: deletePictureForEmployee
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: employee_id
in: path
description: (v1.0) id for employee
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified picture
headers: {}
content: {}
deprecated: false
patch:
tags:
- picture
summary: patchPictureForEmployee
description: Updates an object of type picture in Dynamics 365 Business Central
operationId: patchPictureForEmployee
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: employee_id
in: path
description: (v1.0) id for employee
required: true
style: simple
schema:
type: string
format: uuid
- name: picture_id
in: path
description: (v1.0) id for picture
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/picture1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifiedpicture
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/picture'
deprecated: false
/companies({company_id})/items({item_id})/defaultDimensions:
get:
tags:
- defaultDimensions
summary: listDefaultDimensionsForItem
description: Returns a list of defaultDimensions
operationId: listDefaultDimensionsForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $expand
in: query
description: (v1.0) Entities to expand
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/expand2'
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select6'
responses:
'200':
description: (v1.0) Succesfully returned a list of defaultDimensions
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/CompaniesAPIItemsAPIDefaultDimensionsResponse'
deprecated: false
post:
tags:
- defaultDimensions
summary: postDefaultDimensionsForItem
description: Creates an object of type defaultDimensions in Dynamics 365 Business Central
operationId: postDefaultDimensionsForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/defaultDimensions1'
required: true
responses:
'201':
description: (v1.0) A new defaultDimensions has been succesfully created
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/defaultDimensions'
deprecated: false
/companies({company_id})/items({item_id})/defaultDimensions({defaultDimensions_parentId},{defaultDimensions_dimensionId}):
get:
tags:
- defaultDimensions
summary: getDefaultDimensionsForItem
description: Retrieve the properties and relationships of an object of type defaultDimensions for Dynamics 365 Business Central.
operationId: getDefaultDimensionsForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_parentId
in: path
description: (v1.0) parentId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_dimensionId
in: path
description: (v1.0) dimensionId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
- name: $expand
in: query
description: (v1.0) Entities to expand
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/expand2'
- name: $select
in: query
description: (v1.0) Selected properties to be retrieved
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/select6'
responses:
'200':
description: (v1.0) Succesfully returned the requested defaultDimensions
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/defaultDimensions'
deprecated: false
delete:
tags:
- defaultDimensions
summary: deleteDefaultDimensionsForItem
description: Deletes an object of type defaultDimensions in Dynamics 365 Business Central
operationId: deleteDefaultDimensionsForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_parentId
in: path
description: (v1.0) parentId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_dimensionId
in: path
description: (v1.0) dimensionId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
responses:
'204':
description: (v1.0) Succesfully deleted the specified defaultDimensions
headers: {}
content: {}
deprecated: false
patch:
tags:
- defaultDimensions
summary: patchDefaultDimensionsForItem
description: Updates an object of type defaultDimensions in Dynamics 365 Business Central
operationId: patchDefaultDimensionsForItem
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: item_id
in: path
description: (v1.0) id for item
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_parentId
in: path
description: (v1.0) parentId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
- name: defaultDimensions_dimensionId
in: path
description: (v1.0) dimensionId for defaultDimensions
required: true
style: simple
schema:
type: string
format: uuid
- name: If-Match
in: header
description: (v1.0) Required. When this request header is included and the eTag provided does not match the current tag on the entity, this will not be updated.
required: true
style: simple
schema:
type: string
requestBody:
description: ''
content:
application/json:
schema:
$ref: '#/components/schemas/defaultDimensions1'
required: true
responses:
'200':
description: (v1.0) Succesfully updated the specifieddefaultDimensions
headers: {}
content:
application/json:
schema:
$ref: '#/components/schemas/defaultDimensions'
deprecated: false
/companies({company_id})/defaultDimensions:
get:
tags:
- defaultDimensions
summary: listDefaultDimensions
description: Returns a list of defaultDimensions
operationId: listDefaultDimensions
parameters:
- name: company_id
in: path
description: (v1.0) id for company
required: true
style: simple
schema:
type: string
format: uuid
- name: $top
in: query
description: (v1.0) Number of items to return from the top of the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $skip
in: query
description: (v1.0) Number of items to skip from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $limit
in: query
description: (v1.0) Number of items to return from the list
style: form
explode: true
schema:
type: integer
format: int32
- name: $filter
in: query
description: (v1.0) Filtering expression
style: form
explode: true
schema:
type: string
- name: $expand
in: query
description: (v1.0) Entities to expand
style: form
explode: true
schema:
type: array
items:
$ref: '#/components/schemas/expand