{"note":"OpenAPI conversion -- returning structured metadata","name":"akeneo-com","description":"Akeneo PIM REST API","version":"1.0.0","base_url":"http://demo.akeneo.com","endpoints":137,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Akeneo PIM REST API\n@base http://demo.akeneo.com\n@version 1.0.0\n@auth ApiKey Authorization in header\n@endpoints 137\n@hint download_for_search\n@toc api(137)\n\n@endpoint GET /api/rest/v1/products-uuid\n@desc Get list of products\n@optional {search: any # Filter products, for more details see the Filters section, scope: any # Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section, locales: any # Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section, attributes: any # Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section, pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way, with_attribute_options: any # Return labels of attribute options in the response. See the `linked_data` format section for more details. (Only available since the 5.0 version), with_quality_scores: any # Return product quality scores in the response. (Only available since the 5.0 version), with_completenesses: any # Return product completenesses in the response. (Only available since the 6.0 version)}\n@returns(200) Return products paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/products-uuid\n@desc Create a new product\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/products-uuid\n@desc Update/create several products\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/products-uuid/search\n@desc Search list of products\n@required {body: map}\n@optional {pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return products paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/products-uuid/{uuid}\n@desc Get a product\n@required {uuid: any # Uuid of the resource}\n@optional {with_attribute_options: any # Return labels of attribute options in the response. See the `linked_data` format section for more details. (Only available since the 5.0 version), with_quality_scores: any # Return product quality scores in the response. (Only available since the 5.0 version), with_completenesses: any # Return product completenesses in the response. (Only available since the 6.0 version)}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/products-uuid/{uuid}\n@desc Update/create a product\n@required {uuid: any # Uuid of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint DELETE /api/rest/v1/products-uuid/{uuid}\n@desc Delete a product\n@required {uuid: any # Uuid of the resource}\n@returns(204) No content to return\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint POST /api/rest/v1/products-uuid/{uuid}/proposal\n@desc Submit a draft for approval\n@required {uuid: any # Uuid of the resource}\n@returns(201) Submitted\n@errors {401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/products-uuid/{uuid}/draft\n@desc Get a draft\n@required {uuid: any # Uuid of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/products\n@desc Get list of products\n@optional {search: any # Filter products, for more details see the Filters section, scope: any # Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section, locales: any # Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section, attributes: any # Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section, pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way, with_attribute_options: any # Return labels of attribute options in the response. See the `linked_data` format section for more details. (Only available since the 5.0 version), with_quality_scores: any # Return product quality scores in the response. (Only available since the 5.0 version), with_completenesses: any # Return product completenesses in the response. (Only available since the 6.0 version)}\n@returns(200) Return products paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/products\n@desc Create a new product\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/products\n@desc Update/create several products\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/products/{code}\n@desc Get a product\n@required {code: any # Code of the resource}\n@optional {with_attribute_options: any # Return labels of attribute options in the response. See the `linked_data` format section for more details. (Only available since the 5.0 version), with_quality_scores: any # Return product quality scores in the response. (Only available since the 5.0 version), with_completenesses: any # Return product completenesses in the response. (Only available since the 6.0 version)}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/products/{code}\n@desc Update/create a product\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint DELETE /api/rest/v1/products/{code}\n@desc Delete a product\n@required {code: any # Code of the resource}\n@returns(204) No content to return\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint POST /api/rest/v1/products/{code}/proposal\n@desc Submit a draft for approval\n@required {code: any # Code of the resource}\n@returns(201) Submitted\n@errors {401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/products/{code}/draft\n@desc Get a draft\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/product-models\n@desc Get list of product models\n@optional {search: any # Filter product models, for more details see the Filters section, scope: any # Filter product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter product values via channel section, locales: any # Filter product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter product values via locale section, attributes: any # Filter product values to only return those concerning the given attributes, for more details see the Filter on product values section and the Filter on product model properties section, pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way, with_quality_scores: any # Return product model quality scores in the response. (Only available since the 6.0 version)}\n@returns(200) Return product models paginated\n@errors {401: Authentication required, 406: Not Acceptable, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/product-models\n@desc Create a new product model\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/product-models\n@desc Update/create several product models\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/product-models/{code}\n@desc Get a product model\n@required {code: any # Code of the resource}\n@optional {with_quality_scores: any # Return product model quality scores in the response. (Only available since the 6.0 version)}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/product-models/{code}\n@desc Update/create a product model\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint DELETE /api/rest/v1/product-models/{code}\n@desc Delete a product model\n@required {code: any # Code of the resource}\n@returns(204) No content to return\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint POST /api/rest/v1/product-models/{code}/proposal\n@desc Submit a draft for approval\n@required {code: any # Code of the resource}\n@returns(201) Submitted\n@errors {401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/product-models/{code}/draft\n@desc Get a draft\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/published-products\n@desc Get list of published products\n@optional {search: any # Filter published products, for more details see the Filters section, scope: any # Filter published product values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section, locales: any # Filter published product values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter on published product values section, attributes: any # Filter published product values to only return those concerning the given attributes, for more details see the Filter on product values section, pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return published products paginated\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 406: Not Acceptable, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/published-products/{code}\n@desc Get a published product\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/media-files\n@desc Get a list of product media files\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return media files paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/media-files\n@desc Create a new product media file\n@required {Content-type: any # Equal to 'multipart/form-data', no other value allowed}\n@optional {body: any}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/media-files/{code}\n@desc Get a product media file\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/media-files/{code}/download\n@desc Download a product media file\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint POST /api/rest/v1/jobs/export/{code}\n@desc Launch export job by code\n@required {code: any # Job code}\n@returns(200) OK\n@errors {400: Bad request, 403: Access forbidden, 404: Resource not found, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/jobs/import/{code}\n@desc Launch import job by code\n@required {code: any # Job code}\n@optional {body: any}\n@returns(200) OK\n@errors {400: Bad request, 403: Access forbidden, 404: Resource not found, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/families\n@desc Get list of families\n@optional {search: any # Filter families, for more details see the Filters section., page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return families paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/families\n@desc Create a new family\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/families\n@desc Update/create several families\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/families/{code}\n@desc Get a family\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/families/{code}\n@desc Update/create a family\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint DELETE /api/rest/v1/families/{code}\n@desc Delete a family\n@required {code: any # Code of the resource}\n@returns(204) No content to return\n@errors {403: Access forbidden, 404: Resource not found, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/families/{family_code}/variants\n@desc Get list of family variants\n@required {family_code: any # Code of the family}\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return family variants paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/families/{family_code}/variants\n@desc Create a new family variant\n@required {family_code: any # Code of the family}\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/families/{family_code}/variants\n@desc Update/create several family variants\n@required {family_code: any # Code of the family}\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/families/{family_code}/variants/{code}\n@desc Get a family variant\n@required {family_code: any # Code of the family, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/families/{family_code}/variants/{code}\n@desc Update/create a family variant\n@required {family_code: any # Code of the family, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/attributes\n@desc Get list of attributes\n@optional {search: any # Filter attributes, for more details see the Filters section., page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way, with_table_select_options: any # Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)}\n@returns(200) Return attributes paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/attributes\n@desc Create a new attribute\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/attributes\n@desc Update/create several attributes\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/attributes/{code}\n@desc Get an attribute\n@required {code: any # Code of the resource}\n@optional {with_table_select_options: any # Return the options of 'select' column types (of a table attribute) in the response. (Only available since the 7.0 version)}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/attributes/{code}\n@desc Update/create an attribute\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/attributes/{attribute_code}/options\n@desc Get list of attribute options\n@required {attribute_code: any # Code of the attribute}\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return attribute options paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/attributes/{attribute_code}/options\n@desc Create a new attribute option\n@required {attribute_code: any # Code of the attribute}\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/attributes/{attribute_code}/options\n@desc Update/create several attribute options\n@required {attribute_code: any # Code of the attribute}\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type, 429: Too many requests}\n\n@endpoint GET /api/rest/v1/attributes/{attribute_code}/options/{code}\n@desc Get an attribute option\n@required {attribute_code: any # Code of the attribute, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/attributes/{attribute_code}/options/{code}\n@desc Update/create an attribute option\n@required {attribute_code: any # Code of the attribute, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity, 429: Too many requests}\n\n@endpoint GET /api/rest/v1/attribute-groups\n@desc Get list of attribute groups\n@optional {search: any # Filter attribute groups, for more details see the Filters section., page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return attribute groups paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/attribute-groups\n@desc Create a new attribute group\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/attribute-groups\n@desc Update/create several attribute groups\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/attribute-groups/{code}\n@desc Get an attribute group\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/attribute-groups/{code}\n@desc Update/create an attribute group\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/association-types\n@desc Get a list of association types\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return association types paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/association-types\n@desc Create a new association type\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/association-types\n@desc Update/create several association types\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/association-types/{code}\n@desc Get an association type\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/association-types/{code}\n@desc Update/create an association type\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/channels\n@desc Get a list of channels\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return channels paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/channels\n@desc Create a new channel\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/channels\n@desc Update/create several channels\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/channels/{code}\n@desc Get a channel\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/channels/{code}\n@desc Update/create a channel\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/locales\n@desc Get a list of locales\n@optional {search: any # Filter locales, for more details see the Filters section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return locales paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/locales/{code}\n@desc Get a locale\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/categories\n@desc Get list of categories\n@optional {search: any # Filter categories, for more details see the Filters section., page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way, with_position: any # Return information about category position into its category tree (only available since the 7.0 version)}\n@returns(200) Return categories paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/categories\n@desc Create a new category\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/categories\n@desc Update/create several categories\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/categories/{code}\n@desc Get a category\n@required {code: any # Code of the resource}\n@optional {with_position: any # Return information about category position into its category tree (only available since the 7.0 version)}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/categories/{code}\n@desc Update/create a category\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/category-media-files\n@desc Create a category media file\n@required {Content-type: any # Equal to 'multipart/form-data'.}\n@optional {body: any}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/category-media-files/{file_path}/download\n@desc Download a category media file\n@required {file_path: any # Path of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/currencies\n@desc Get a list of currencies\n@optional {search: any # Filter currencies, for more details see the Filters section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Return currencies paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/currencies/{code}\n@desc Get a currency\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/measure-families\n@desc Get list of measure families (deprecated as of v5.0)\n@returns(200) Return measure families paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/measure-families/{code}\n@desc Get a measure family (deprecated as of v5.0)\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/measurement-families\n@desc Get list of measurement families\n@returns(200) Return the measurement families\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/measurement-families\n@desc Update/create several measurement families\n@optional {body: [map]}\n@returns(200) OK\n@errors {401: Authentication required, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/reference-entities\n@desc Get list of reference entities\n@optional {search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section}\n@returns(200) Return reference entities paginated\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/reference-entities/{code}\n@desc Get a reference entity\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/reference-entities/{code}\n@desc Update/create a reference entity\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes\n@desc Get the list of attributes of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity}\n@returns(200) Return the attributes of the given reference entity\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}\n@desc Get an attribute of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{code}\n@desc Update/create an attribute of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options\n@desc Get a list of attribute options of a given attribute for a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, attribute_code: any # Code of the attribute}\n@returns(200) Return the options of the given attributes of the given reference entity\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}\n@desc Get an attribute option for a given attribute of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, attribute_code: any # Code of the attribute, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/attributes/{attribute_code}/options/{code}\n@desc Update/create a reference entity attribute option\n@required {reference_entity_code: any # Code of the reference entity, attribute_code: any # Code of the attribute, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/records\n@desc Get the list of the records of a reference entity\n@required {reference_entity_code: any # Code of the reference entity}\n@optional {search: any # Filter records of the reference entity, for more details see the Filters section, channel: any # Filter attribute values to return scopable attributes for the given channel as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by channel section, locales: any # Filter attribute values to return localizable attributes for the given locales as well as the non localizable/non scopable attributes, for more details see the Filter attribute values by locale section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section}\n@returns(200) Return the records of the given reference entity paginated\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records\n@desc Update/create several reference entity records\n@required {reference_entity_code: any # Code of the reference entity, body: [map]}\n@returns(200) OK\n@errors {401: Authentication required, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}\n@desc Get a record of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/reference-entities/{reference_entity_code}/records/{code}\n@desc Update/create a record of a given reference entity\n@required {reference_entity_code: any # Code of the reference entity, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/reference-entities-media-files\n@desc Create a new media file for a reference entity or a record\n@required {Content-type: any # Equal to 'multipart/form-data', no other value allowed}\n@optional {body: any}\n@returns(201) Created\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/reference-entities-media-files/{code}\n@desc Download the media file associated to a reference entity or a record\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/asset-families\n@desc Get list of asset families\n@optional {search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section}\n@returns(200) Return asset families paginated\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/asset-families/{code}\n@desc Get an asset family\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-families/{code}\n@desc Update/create an asset family\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes\n@desc Get the list of attributes of a given asset family\n@required {asset_family_code: any # Code of the asset family}\n@returns(200) Return the attributes of the given asset family\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}\n@desc Get an attribute of a given asset family\n@required {asset_family_code: any # Code of the asset family, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{code}\n@desc Update/create an attribute of a given asset family\n@required {asset_family_code: any # Code of the asset family, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options\n@desc Get a list of attribute options of a given attribute for a given asset family\n@required {asset_family_code: any # Code of the asset family, attribute_code: any # Code of the attribute}\n@returns(200) Return the options of the given attribute of the given asset family\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}\n@desc Get an attribute option for a given attribute of a given asset family\n@required {asset_family_code: any # Code of the asset family, attribute_code: any # Code of the attribute, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/attributes/{attribute_code}/options/{code}\n@desc Update/create an asset attribute option for a given asset family\n@required {asset_family_code: any # Code of the asset family, attribute_code: any # Code of the attribute, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint POST /api/rest/v1/asset-media-files\n@desc Create a new media file for an asset\n@required {Content-type: any # Equal to 'multipart/form-data', no other value allowed}\n@optional {body: any}\n@returns(201) Created\n@errors {401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/asset-media-files/{code}\n@desc Download the media file associated to an asset\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/assets\n@desc Get the list of the assets of a given asset family\n@required {asset_family_code: any # Code of the asset family}\n@optional {search: any # Filter assets, for more details see the Asset filters section, channel: any # Filter asset values to return scopable asset attributes for the given channel as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by channel section, locales: any # Filter asset values to return localizable attributes for the given locales as well as the non localizable/non scopable asset attributes, for more details see the Filter asset values by locale section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section}\n@returns(200) Return the assets of the given asset family paginated\n@errors {401: Authentication required, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/assets\n@desc Update/create several assets\n@required {asset_family_code: any # Code of the asset family, body: [map]}\n@returns(200) OK\n@errors {400: Bad request, 401: Authentication required, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/asset-families/{asset_family_code}/assets/{code}\n@desc Get an asset of a given asset family\n@required {asset_family_code: any # Code of the asset family, code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-families/{asset_family_code}/assets/{code}\n@desc Update/create an asset\n@required {asset_family_code: any # Code of the asset family, code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint DELETE /api/rest/v1/asset-families/{asset_family_code}/assets/{code}\n@desc Delete an asset\n@required {asset_family_code: any # Code of the asset family, code: any # Code of the resource}\n@returns(204) No content to return\n@errors {401: Authentication required, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/assets\n@desc Get list of PAM assets\n@optional {pagination_type: any # Pagination method type, see Pagination section, page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, search_after: any # Cursor when using the `search_after` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Returns PAM assets paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/assets\n@desc Create a new PAM asset\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/assets\n@desc Update/create several PAM assets\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/assets/{code}\n@desc Get a PAM asset\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/assets/{code}\n@desc Update/create a PAM asset\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}\n@desc Get a reference file\n@required {asset_code: any # Code of the asset, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}\n@desc Upload a new reference file\n@required {asset_code: any # Code of the asset, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable, Content-type: any # Equal to 'multipart/form-data', no other value allowed}\n@optional {body: any}\n@returns(201) Uploaded\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 404: Resource not found, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/assets/{asset_code}/reference-files/{locale_code}/download\n@desc Download a reference file\n@required {asset_code: any # Code of the asset, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}\n@desc Get a variation file\n@required {asset_code: any # Code of the asset, channel_code: any # Code of the channel, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}\n@desc Upload a new variation file\n@required {asset_code: any # Code of the asset, channel_code: any # Code of the channel, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable, Content-type: any # Equal to 'multipart/form-data', no other value allowed}\n@optional {body: any}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 404: Resource not found, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/assets/{asset_code}/variation-files/{channel_code}/{locale_code}/download\n@desc Download a variation file\n@required {asset_code: any # Code of the asset, channel_code: any # Code of the channel, locale_code: any # Code of the locale if the asset is localizable or equal to `no-locale` if the asset is not localizable}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found}\n\n@endpoint GET /api/rest/v1/asset-categories\n@desc Get list of PAM asset categories\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Returns PAM asset categories paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint POST /api/rest/v1/asset-categories\n@desc Create a new PAM asset category\n@optional {body: map}\n@returns(201) Created\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint PATCH /api/rest/v1/asset-categories\n@desc Update/create several PAM asset categories\n@optional {body: map}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 413: Request Entity Too Large, 415: Unsupported Media type}\n\n@endpoint GET /api/rest/v1/asset-categories/{code}\n@desc Get a PAM asset category\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-categories/{code}\n@desc Update/create a PAM asset category\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/asset-tags\n@desc Get list of PAM asset tags\n@optional {page: any # Number of the page to retrieve when using the `page` pagination method type. Should never be set manually, see Pagination section, limit: any # Number of results by page, see Pagination section, with_count: any # Return the count of items in the response. Be carefull with that, on a big catalog, it can decrease performance in a significative way}\n@returns(200) Returns PAM asset tags paginated\n@errors {401: Authentication required, 403: Access forbidden, 406: Not Acceptable}\n\n@endpoint GET /api/rest/v1/asset-tags/{code}\n@desc Get a PAM asset tag\n@required {code: any # Code of the resource}\n@returns(200) OK\n@errors {401: Authentication required, 403: Access forbidden, 404: Resource not found, 406: Not Acceptable}\n\n@endpoint PATCH /api/rest/v1/asset-tags/{code}\n@desc Update/create a PAM asset tag\n@required {code: any # Code of the resource, body: map}\n@returns(201) Created\n@returns(204) No content to return\n@errors {400: Bad request, 401: Authentication required, 403: Access forbidden, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1\n@desc Get list of all endpoints\n@returns(200) Return the list of all available endpoints\n@errors {406: Not Acceptable}\n\n@endpoint POST /api/oauth/v1/token\n@desc Get authentication token\n@required {Content-type: any # Equal to 'application/json' or 'application/x-www-form-urlencoded', no other value allowed, Authorization: any # Equal to 'Basic xx', where 'xx' is the base 64 encoding of the client id and secret. Find out how to generate them in the Client ID/secret generation section.}\n@optional {body: map}\n@returns(200) Return an authentication token\n@errors {400: Bad request, 415: Unsupported Media type, 422: Unprocessable entity}\n\n@endpoint GET /api/rest/v1/system-information\n@desc Get system information\n@returns(200) Return the version and the edition of the PIM.\n@errors {406: Not Acceptable}\n\n@end\n"}