action POST v1.0.0
Adds or replaces aliases for single ID4ns (alias type item and mapp) or groups of ID4ns (alias types gtin, ean and article)
swirls add id4i add_guid_alias Source action POST v1.0.0
swirls add id4i add_elements_to_collection Source action POST v1.0.0
Add a new history item
swirls add id4i add_item Source action POST v1.0.0
swirls add id4i add_api_key_privilege_for_id4ns Source action PUT v1.0.0
Adding a partner organization. If the given organization is already a partner the result will be state 200 too.
swirls add id4i add_partner_organization Source action POST v1.0.0
swirls add id4i add_api_key_privilege Source action POST v1.0.0
swirls add id4i add_user_roles Source action PATCH v1.0.0
Allows ownership transfer.
swirls add id4i update_guid Source action PUT v1.0.0
Completing a registration e.g. for invited users. Finish registration with a username and a password.
swirls add id4i complete_registration Source action POST v1.0.0
The documents' mime type is suggested on octet-stream data. Otherwise the specified content mime type is used.
swirls add id4i create_document Source action POST v1.0.0
Creation of a new API key.
swirls add id4i create_new_api_key Source action POST v1.0.0
swirls add id4i create_collection Source action POST v1.0.0
Creating one or more GUIDs with a specified length.
swirls add id4i create_guid Source action POST v1.0.0
Creating a new organization.
swirls add id4i create_organization Source action DELETE v1.0.0
swirls add id4i delete_document Source action DELETE v1.0.0
Deletion of an API key.
swirls add id4i delete_api_key Source action DELETE v1.0.0
swirls add id4i delete_collection Source action DELETE v1.0.0
Partial deletion of id4n properties. If the property does not exist, it will be ignored.
swirls add id4i delete_properties Source action DELETE v1.0.0
swirls add id4i delete_organization Source action DELETE v1.0.0
swirls add id4i delete_organization_logo Source action POST v1.0.0
Enqueue a custom organisation message with custom data.
swirls add id4i enqueue_custom_message Source action GET v1.0.0
Finding all API key assigned to the specified organization in a paginated manner.
swirls add id4i list_all_api_keys_of_organization Source action GET v1.0.0
swirls add id4i find_user_by_username Source action GET v1.0.0
swirls add id4i find_collection Source action GET v1.0.0
Returns a single organization.
swirls add id4i find_organization Source action GET v1.0.0
swirls add id4i find_users Source action GET v1.0.0
Finding users in the specified organization in a paginated manner.
swirls add id4i get_users_of_organization Source action GET v1.0.0
Forwarding to the designated route defined in the routing,
action GET v1.0.0
Looks up the alias for each alias type (group and single) and returns a map of all aliases found.
swirls add id4i get_guid_aliases Source action GET v1.0.0
swirls add id4i get_sum_for_organization Source action GET v1.0.0
swirls add id4i get_positions_for_organization Source action GET v1.0.0
Retrieving all collections of an organization in a paginated manner. You may filter the results by specifying id4n properties with filter operations (eq, in, ne) in the query parameters. e.g. `com.yourcompany.orderId.eq=1234`
swirls add id4i get_all_collections_of_organization Source action GET v1.0.0
swirls add id4i retrieve_item Source action GET v1.0.0
Get a list of ID4n properties for the specified ID4ns.
swirls add id4i get_multiple_properties Source action GET v1.0.0
Listing partners in a paginated manner.
swirls add id4i get_partner_organizations Source action GET v1.0.0
swirls add id4i get_user_roles Source action GET v1.0.0
swirls add id4i get_default_queue Source action GET v1.0.0
Listing ID4ns of a id4n concerning privilege
swirls add id4i list_id4ns Source action POST v1.0.0
swirls add id4i invite_users Source action GET v1.0.0
Listing all possible API key privileges.
swirls add id4i list_all_api_key_privileges Source action GET v1.0.0
Retrieve this list to find out all alias types to use with alias search and change operations
swirls add id4i get_guid_alias_types Source action GET v1.0.0
Listing change log entries of the specified organization id.
swirls add id4i list_organization_change_log Source action GET v1.0.0
swirls add id4i list_elements_of_collection Source action GET v1.0.0
swirls add id4i list_countries Source action GET v1.0.0
Listing all documents of an id4n
swirls add id4i list_all_documents Source action GET v1.0.0
Lists the history of a GUID
swirls add id4i filtered_list Source action GET v1.0.0
Listing all privileges of the current user/APIKey of the specified organization.
swirls add id4i get_organization_privileges Source action GET v1.0.0
Listing documents of an id4n seen by a specified organization
swirls add id4i list_documents Source action GET v1.0.0
swirls add id4i list_api_key_privileges Source action GET v1.0.0
Listing all public documents of an id4n
swirls add id4i list_all_public_documents Source action GET v1.0.0
Listing of roles.
swirls add id4i list_all_roles Source action GET v1.0.0
Listing users and their roles in a paginated manner.
swirls add id4i get_all_organization_roles Source action POST v1.0.0
ID4i API Login
action PATCH v1.0.0
Partial updating of id4n properties. If a property contains a null value the property will be deleted other values will be saved and overwritten if they already exist.
swirls add id4i patch_properties Source action PATCH v1.0.0
swirls add id4i patch_default_queue Source action PUT v1.0.0
Creating or overwriting an existing document
swirls add id4i put_document Source action GET v1.0.0
swirls add id4i read_from_microstorage Source action GET v1.0.0
swirls add id4i read_document Source action GET v1.0.0
swirls add id4i read_public_document Source action GET v1.0.0
swirls add id4i read_organization_info Source action POST v1.0.0
Registering a new user.
swirls add id4i register_user Source action DELETE v1.0.0
Remove the alias of the given type
swirls add id4i remove_guid_alias Source action DELETE v1.0.0
swirls add id4i delete_organization_billing_address Source action DELETE v1.0.0
swirls add id4i remove_elements_from_collection Source action DELETE v1.0.0
swirls add id4i remove_api_key_privilege_for_id4ns Source action DELETE v1.0.0
Removing a partner organization
swirls add id4i remove_partner_organization Source action DELETE v1.0.0
swirls add id4i remove_api_key_privilege Source action DELETE v1.0.0
swirls add id4i remove_user_roles Source action POST v1.0.0
Requesting a reset for a new password.
swirls add id4i request_password_reset Source action GET v1.0.0
swirls add id4i resolve_image_using_get Source action GET v1.0.0
swirls add id4i resolve_who_is_entry Source action GET v1.0.0
swirls add id4i get_document Source action GET v1.0.0
swirls add id4i get_public_document Source action GET v1.0.0
swirls add id4i find_organization_address Source action GET v1.0.0
swirls add id4i get_routes Source action GET v1.0.0
swirls add id4i get_all_routes Source action GET v1.0.0
swirls add id4i find_organization_billing_address Source action GET v1.0.0
Retrieving all owned or holding collections the specified id4n is assigned to.
swirls add id4i get_collections Source action GET v1.0.0
swirls add id4i get_route Source action GET v1.0.0
swirls add id4i get_guid Source action GET v1.0.0
swirls add id4i get_guids_without_collection Source action GET v1.0.0
Retrieving basic information about an ID like the type and the creation time.
swirls add id4i get_id4n Source action GET v1.0.0
List all properties of an id4n.
swirls add id4i get_properties Source action GET v1.0.0
swirls add id4i get_organizations_of_user Source action GET v1.0.0
swirls add id4i get_routing_file Source action GET v1.0.0
swirls add id4i search_by_alias Source action PUT v1.0.0
swirls add id4i update_item_visibility Source action GET v1.0.0
Showing the details of an API key.
swirls add id4i get_api_key Source action GET v1.0.0
swirls add id4i get_send_info Source action GET v1.0.0
Only contains public history items
swirls add id4i list_public_history Source action PUT v1.0.0
swirls add id4i update_organization_address Source action PUT v1.0.0
swirls add id4i update_organization_billing_address Source action PUT v1.0.0
swirls add id4i update_routing_file Source action PATCH v1.0.0
swirls add id4i update_document_metadata Source action PUT v1.0.0
API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.
swirls add id4i update_api_key Source action PATCH v1.0.0
Update collection changing only the given values
swirls add id4i update_collection Source action PATCH v1.0.0
swirls add id4i update_item Source action PUT v1.0.0
swirls add id4i update_organization Source action POST v1.0.0
Updating an organization logo using a multipart file upload.
swirls add id4i set_organization_logo Source action POST v1.0.0
Verifies a new user registration.
swirls add id4i verify_user_registration Source