@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Akeneo PIM REST API
@base http://demo.akeneo.com
@version 1.0.0
@auth ApiKey Authorization in header
@endpoints 137
@hint download_for_search
@toc api(137)

@endpoint GET /api/rest/v1/products-uuid
@optional {search: any, scope: any, locales: any, attributes: any, pagination_type: any, page: any, search_after: any, limit: any, with_count: any, with_attribute_options: any, with_quality_scores: any, with_completenesses: any}
@returns(200)
@errors {401, 403, 406, 422}

@endpoint POST /api/rest/v1/products-uuid
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/products-uuid
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415, 422}

@endpoint POST /api/rest/v1/products-uuid/search
@required {body: map}
@optional {pagination_type: any, page: any, search_after: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406, 422}

@endpoint GET /api/rest/v1/products-uuid/{uuid}
@required {uuid: any}
@optional {with_attribute_options: any, with_quality_scores: any, with_completenesses: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/products-uuid/{uuid}
@required {uuid: any, body: map}
@returns(201)
@returns(204)
@errors {401, 403, 415, 422}

@endpoint DELETE /api/rest/v1/products-uuid/{uuid}
@required {uuid: any}
@returns(204)
@errors {401, 403, 404}

@endpoint POST /api/rest/v1/products-uuid/{uuid}/proposal
@required {uuid: any}
@returns(201)
@errors {401, 403, 415, 422}

@endpoint GET /api/rest/v1/products-uuid/{uuid}/draft
@required {uuid: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/products
@optional {search: any, scope: any, locales: any, attributes: any, pagination_type: any, page: any, search_after: any, limit: any, with_count: any, with_attribute_options: any, with_quality_scores: any, with_completenesses: any}
@returns(200)
@errors {401, 403, 406, 422}

@endpoint POST /api/rest/v1/products
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/products
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/products/{code}
@required {code: any}
@optional {with_attribute_options: any, with_quality_scores: any, with_completenesses: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/products/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 403, 415, 422}

@endpoint DELETE /api/rest/v1/products/{code}
@required {code: any}
@returns(204)
@errors {401, 403, 404}

@endpoint POST /api/rest/v1/products/{code}/proposal
@required {code: any}
@returns(201)
@errors {401, 403, 415, 422}

@endpoint GET /api/rest/v1/products/{code}/draft
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/product-models
@optional {search: any, scope: any, locales: any, attributes: any, pagination_type: any, page: any, search_after: any, limit: any, with_count: any, with_quality_scores: any}
@returns(200)
@errors {401, 406, 422}

@endpoint POST /api/rest/v1/product-models
@optional {body: map}
@returns(201)
@errors {400, 401, 415, 422}

@endpoint PATCH /api/rest/v1/product-models
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/product-models/{code}
@required {code: any}
@optional {with_quality_scores: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/product-models/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint DELETE /api/rest/v1/product-models/{code}
@required {code: any}
@returns(204)
@errors {401, 403, 404}

@endpoint POST /api/rest/v1/product-models/{code}/proposal
@required {code: any}
@returns(201)
@errors {401, 403, 415, 422}

@endpoint GET /api/rest/v1/product-models/{code}/draft
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/published-products
@optional {search: any, scope: any, locales: any, attributes: any, pagination_type: any, page: any, search_after: any, limit: any, with_count: any}
@returns(200)
@errors {400, 401, 403, 406, 422}

@endpoint GET /api/rest/v1/published-products/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/media-files
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/media-files
@required {Content-type: any}
@optional {body: any}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/media-files/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/media-files/{code}/download
@required {code: any}
@returns(200)
@errors {401, 403, 404}

@endpoint POST /api/rest/v1/jobs/export/{code}
@required {code: any}
@returns(200)
@errors {400, 403, 404, 422}

@endpoint POST /api/rest/v1/jobs/import/{code}
@required {code: any}
@optional {body: any}
@returns(200)
@errors {400, 403, 404, 422}

@endpoint GET /api/rest/v1/families
@optional {search: any, page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/families
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/families
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/families/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/families/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint DELETE /api/rest/v1/families/{code}
@required {code: any}
@returns(204)
@errors {403, 404, 422}

@endpoint GET /api/rest/v1/families/{family_code}/variants
@required {family_code: any}
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/families/{family_code}/variants
@required {family_code: any}
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/families/{family_code}/variants
@required {family_code: any}
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/families/{family_code}/variants/{code}
@required {family_code: any, code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/families/{family_code}/variants/{code}
@required {family_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/attributes
@optional {search: any, page: any, limit: any, with_count: any, with_table_select_options: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/attributes
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/attributes
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/attributes/{code}
@required {code: any}
@optional {with_table_select_options: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/attributes/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/attributes/{attribute_code}/options
@required {attribute_code: any}
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/attributes/{attribute_code}/options
@required {attribute_code: any}
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/attributes/{attribute_code}/options
@required {attribute_code: any}
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415, 429}

@endpoint GET /api/rest/v1/attributes/{attribute_code}/options/{code}
@required {attribute_code: any, code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/attributes/{attribute_code}/options/{code}
@required {attribute_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422, 429}

@endpoint GET /api/rest/v1/attribute-groups
@optional {search: any, page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/attribute-groups
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/attribute-groups
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/attribute-groups/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/attribute-groups/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/association-types
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/association-types
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/association-types
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/association-types/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/association-types/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/channels
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/channels
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/channels
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/channels/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/channels/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/locales
@optional {search: any, page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint GET /api/rest/v1/locales/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/categories
@optional {search: any, page: any, limit: any, with_count: any, with_position: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/categories
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/categories
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/categories/{code}
@required {code: any}
@optional {with_position: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/categories/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint POST /api/rest/v1/category-media-files
@required {Content-type: any}
@optional {body: any}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/category-media-files/{file_path}/download
@required {file_path: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /api/rest/v1/currencies
@optional {search: any, page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint GET /api/rest/v1/currencies/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/measure-families
@returns(200)
@errors {401, 403, 406}

@endpoint GET /api/rest/v1/measure-families/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint GET /api/rest/v1/measurement-families
@returns(200)
@errors {401, 406}

@endpoint PATCH /api/rest/v1/measurement-families
@optional {body: [map]}
@returns(200)
@errors {401, 413, 415}

@endpoint GET /api/rest/v1/reference-entities
@optional {search_after: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/reference-entities/{code}
@required {code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/reference-entities/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes
@required {reference_entity_code: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
@required {reference_entity_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}
@required {reference_entity_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options
@required {reference_entity_code: any, attribute_code: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
@required {reference_entity_code: any, attribute_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}
@required {reference_entity_code: any, attribute_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/records
@required {reference_entity_code: any}
@optional {search: any, channel: any, locales: any, search_after: any}
@returns(200)
@errors {401, 406}

@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records
@required {reference_entity_code: any, body: [map]}
@returns(200)
@errors {401, 413, 415}

@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
@required {reference_entity_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}
@required {reference_entity_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint POST /api/rest/v1/reference-entities-media-files
@required {Content-type: any}
@optional {body: any}
@returns(201)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/reference-entities-media-files/{code}
@required {code: any}
@returns(200)
@errors {401, 404}

@endpoint GET /api/rest/v1/asset-families
@optional {search_after: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/asset-families/{code}
@required {code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/asset-families/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes
@required {asset_family_code: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
@required {asset_family_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}
@required {asset_family_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options
@required {asset_family_code: any, attribute_code: any}
@returns(200)
@errors {401, 406}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
@required {asset_family_code: any, attribute_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}
@required {asset_family_code: any, attribute_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {401, 415, 422}

@endpoint POST /api/rest/v1/asset-media-files
@required {Content-type: any}
@optional {body: any}
@returns(201)
@errors {401, 415, 422}

@endpoint GET /api/rest/v1/asset-media-files/{code}
@required {code: any}
@returns(200)
@errors {401, 404}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/assets
@required {asset_family_code: any}
@optional {search: any, channel: any, locales: any, search_after: any}
@returns(200)
@errors {401, 406}

@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/assets
@required {asset_family_code: any, body: [map]}
@returns(200)
@errors {400, 401, 413, 415}

@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
@required {asset_family_code: any, code: any}
@returns(200)
@errors {401, 404, 406}

@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
@required {asset_family_code: any, code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 415, 422}

@endpoint DELETE /api/rest/v1/asset-families/{asset_family_code}/assets/{code}
@required {asset_family_code: any, code: any}
@returns(204)
@errors {401, 404}

@endpoint GET /api/rest/v1/assets
@optional {pagination_type: any, page: any, search_after: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/assets
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/assets
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/assets/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/assets/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}
@required {asset_code: any, locale_code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint POST /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}
@required {asset_code: any, locale_code: any, Content-type: any}
@optional {body: any}
@returns(201)
@errors {400, 401, 403, 404, 415, 422}

@endpoint GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download
@required {asset_code: any, locale_code: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}
@required {asset_code: any, channel_code: any, locale_code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint POST /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}
@required {asset_code: any, channel_code: any, locale_code: any, Content-type: any}
@optional {body: any}
@returns(201)
@errors {400, 401, 403, 404, 415, 422}

@endpoint GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download
@required {asset_code: any, channel_code: any, locale_code: any}
@returns(200)
@errors {401, 403, 404}

@endpoint GET /api/rest/v1/asset-categories
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint POST /api/rest/v1/asset-categories
@optional {body: map}
@returns(201)
@errors {400, 401, 403, 415, 422}

@endpoint PATCH /api/rest/v1/asset-categories
@optional {body: map}
@returns(200)
@errors {401, 403, 413, 415}

@endpoint GET /api/rest/v1/asset-categories/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/asset-categories/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1/asset-tags
@optional {page: any, limit: any, with_count: any}
@returns(200)
@errors {401, 403, 406}

@endpoint GET /api/rest/v1/asset-tags/{code}
@required {code: any}
@returns(200)
@errors {401, 403, 404, 406}

@endpoint PATCH /api/rest/v1/asset-tags/{code}
@required {code: any, body: map}
@returns(201)
@returns(204)
@errors {400, 401, 403, 415, 422}

@endpoint GET /api/rest/v1
@returns(200)
@errors {406}

@endpoint POST /api/oauth/v1/token
@required {Content-type: any, Authorization: any}
@optional {body: map}
@returns(200)
@errors {400, 415, 422}

@endpoint GET /api/rest/v1/system-information
@returns(200)
@errors {406}

@end