Akeneo API client v0.1.1 AkeneoApi.Endpoint.V1.ReferenceEntities View Source

Link to this section Summary

Functions

This endpoint allows you to get a list of reference entities. Reference entities are paginated.

This endpoint allows you to get the information about a given reference entity.

This endpoint allows you to get the list of attributes of a given reference entity.

This endpoint allows you to get the information about a given attribute for a given reference entity.

This endpoint allows you to get a list of attribute options for a given reference entity. Reference entity attribute options are paginated.

This endpoint allows you to get the information about a given attribute option.

This endpoint allows you to get a list of records of a given reference entity. Records are paginated and can be filtered.

This endpoint allows you to get the information about a given record for a given reference entity.

This endpoint allows you to update a given reference entity. Note that if the reference entity does not already exist, it creates it.

This endpoint allows you to update a given attribute for a given renference entity. Note that if the attribute does not already exist for the given reference entity, it creates it.

This endpoint allows you to update a given option for a given attribute and a given reference entity. Learn more about Update behavior. Note that if the option does not already exist for the given attribute of the given reference entity, it creates it.

This endpoint allows you to update and/or create several records of one given reference entity at once. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.

This endpoint allows you to update a given record of a given renference entity. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.

Link to this section Functions

Link to this function

get_reference_entities() View Source

This endpoint allows you to get a list of reference entities. Reference entities are paginated.

Link to this function

get_reference_entities(opts) View Source

This endpoint allows you to get the information about a given reference entity.

Link to this function

get_reference_entities__code__attributes(reference_entity_code) View Source

This endpoint allows you to get the list of attributes of a given reference entity.

Link to this function

get_reference_entity_attributes(reference_entity_code, code) View Source

This endpoint allows you to get the information about a given attribute for a given reference entity.

Link to this function

get_reference_entity_attributesoptions(reference_entity_code, attribute_code) View Source

This endpoint allows you to get a list of attribute options for a given reference entity. Reference entity attribute options are paginated.

Link to this function

get_reference_entity_attributesoptions(reference_entity_code, attribute_code, code) View Source

This endpoint allows you to get the information about a given attribute option.

Link to this function

get_reference_entity_records(reference_entity_code) View Source

This endpoint allows you to get a list of records of a given reference entity. Records are paginated and can be filtered.

Link to this function

get_reference_entity_records(reference_entity_code, opts) View Source

This endpoint allows you to get the information about a given record for a given reference entity.

Link to this function

patch_reference_entity(code, opts) View Source

This endpoint allows you to update a given reference entity. Note that if the reference entity does not already exist, it creates it.

Link to this function

patch_reference_entity_attributes(reference_entity_code, code, opts) View Source

This endpoint allows you to update a given attribute for a given renference entity. Note that if the attribute does not already exist for the given reference entity, it creates it.

Link to this function

patch_reference_entity_attributesoptions(reference_entity_code, attribute_code, code, opts) View Source

This endpoint allows you to update a given option for a given attribute and a given reference entity. Learn more about Update behavior. Note that if the option does not already exist for the given attribute of the given reference entity, it creates it.

Link to this function

patch_reference_entity_records(reference_entity_code, opts) View Source

This endpoint allows you to update and/or create several records of one given reference entity at once. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.

Link to this function

patch_reference_entity_records(reference_entity_code, code, opts) View Source

This endpoint allows you to update a given record of a given renference entity. Learn more about Update behavior. Note that if the record does not already exist for the given reference entity, it creates it.