ID4i API

Tools (109)

Extracted live via the executor SDK.

• accounts.addUserRoles

  Add role(s) to user

• accounts.completeRegistration

  Completing a registration e.g. for invited users. Finish registration with a username and a password.

• accounts.findUserByUsername

  Find by username

• accounts.findUsers

  Find users

• accounts.getAllOrganizationRoles

  Listing users and their roles in a paginated manner.

• accounts.getOrganizationsOfUser

  Retrieve organizations of user

• accounts.getUserRoles

  Get user roles by username

• accounts.getUsersOfOrganization

  Finding users in the specified organization in a paginated manner.

• accounts.inviteUsers

  Invite Users

• accounts.listAllRoles

  Listing of roles.

• accounts.login

  ID4i API Login

• accounts.registerUser

  Registering a new user.

• accounts.removeUserRoles

  Remove role(s) from user

• accounts.requestPasswordReset

  Requesting a reset for a new password.

• accounts.verifyPasswordReset

  Setting a new password and verifying the request to set the password.

• accounts.verifyUserRegistration

  Verifies a new user registration.

• alias.addGuidAlias

  Adds or replaces aliases for single ID4ns (alias type item and mapp) or groups of ID4ns (alias types gtin, ean and article)

• alias.getGuidAliases

  Looks up the alias for each alias type (group and single) and returns a map of all aliases found.

• alias.getGuidAliasTypes

  Retrieve this list to find out all alias types to use with alias search and change operations

• alias.removeGuidAlias

  Remove the alias of the given type

• alias.searchByAlias

  Search for GUIDs by alias

• apiKeys.addApiKeyPrivilege

  Add privilege

• apiKeys.addApiKeyPrivilegeForId4ns

  Add ID4ns of a privilege

• apiKeys.createNewApiKey

  Creation of a new API key.

• apiKeys.deleteApiKey

  Deletion of an API key.

• apiKeys.getApiKey

  Showing the details of an API key.

• apiKeys.listAllApiKeyPrivileges

  Listing all possible API key privileges.

• apiKeys.listAllApiKeysOfOrganization

  Finding all API key assigned to the specified organization in a paginated manner.

• apiKeys.listApiKeyPrivileges

  List privileges

• apiKeys.listId4ns

  Listing ID4ns of a id4n concerning privilege

• apiKeys.removeApiKeyPrivilege

  Remove privilege

• apiKeys.removeApiKeyPrivilegeForId4ns

  Remove id4ns of a privilege

• apiKeys.updateApiKey

  API keys can be updated with new labels, and be activated and deactivated. The secret or UUID cannot be changed.

• auditing.listOrganizationChangeLog

  Listing change log entries of the specified organization id.

• billing.getPositionsForOrganization

  Get billing positions for a given organization

• billing.getSumForOrganization

  Get billing amount of services for a given organization

• collections.addElementsToCollection

  Add elements to collection

• collections.createCollection

  Create collection

• collections.deleteCollection

  Delete collection

• collections.deleteProperties

  Partial deletion of id4n properties. If the property does not exist, it will be ignored.

• collections.findCollection

  Find collection

• collections.getAllCollectionsOfOrganization

  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

• collections.getMultipleProperties

  Get a list of ID4n properties for the specified ID4ns.

• collections.getProperties

  List all properties of an id4n.

• collections.listElementsOfCollection

  List contents of the collection

• collections.patchProperties

  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.

• collections.removeElementsFromCollection

  Remove elements from collection

• collections.updateCollection

  Update collection changing only the given values

• guids.createGuid

  Creating one or more GUIDs with a specified length.

• guids.getCollections

  Retrieving all owned or holding collections the specified id4n is assigned to.

• guids.getGuid

  Retrieve GUID information

• guids.getGuidsWithoutCollection

  Retrieve GUIDs not in any collection

• guids.getId4n

  Retrieving basic information about an ID like the type and the creation time.

• guids.importGS1Codes

  Importing GS1/MAPP codes that contain unique components.

• guids.updateGuid

  Allows ownership transfer.

• history.addItem

  Add a new history item

• history.filteredList

  Lists the history of a GUID

• history.list

  DEPRECATED - please use filteredList with organization parameter to achieve the same functionality

• history.retrieveItem

  Get history item

• history.updateItem

  Update history item

• history.updateItemVisibility

  Set history item visibility

• images.resolveImageUsingGet

  Resolve image

• messaging.enqueueCustomMessage

  Enqueue a custom organisation message with custom data.

• messaging.getDefaultQueue

  GET /api/v1/organizations/{organizationId}/messaging

• messaging.patchDefaultQueue

  PATCH /api/v1/organizations/{organizationId}/messaging

• metaInformation.applicationInfo

  Retrieving version information about ID4i.

• organizations.addPartnerOrganization

  Adding a partner organization. If the given organization is already a partner the result will be state 200 too.

• organizations.createOrganization

  Creating a new organization.

• organizations.deleteOrganization

  Delete organization

• organizations.deleteOrganizationBillingAddress

  Remove billing address

• organizations.deleteOrganizationLogo

  Delete organization logo

• organizations.findOrganization

  Returns a single organization.

• organizations.findOrganizationAddress

  Retrieve address

• organizations.findOrganizationBillingAddress

  Retrieve billing address

• organizations.getOrganizationPrivileges

  Listing all privileges of the current user/APIKey of the specified organization.

• organizations.getPartnerOrganizations

  Listing partners in a paginated manner.

• organizations.listCountries

  List countries

• organizations.removePartnerOrganization

  Removing a partner organization

• organizations.setOrganizationLogo

  Updating an organization logo using a multipart file upload.

• organizations.updateOrganization

  Update organization

• organizations.updateOrganizationAddress

  Store address

• organizations.updateOrganizationBillingAddress

  Store billing address

• publicServices.getPublicDocument

  Retrieve a public document (meta-data only, no content)

• publicServices.getRoutes

  Retrieve all public routes for a GUID

• publicServices.go

  Forwarding to the designated route defined in the routing,

• publicServices.listAllPublicDocuments

  Listing all public documents of an id4n

• publicServices.listPublicHistory

  Only contains public history items

• publicServices.readOrganizationInfo

  Read public organization information

• publicServices.readPublicDocument

  Read public document contents

• publicServices.resolveWhoIsEntry

  Resolve owner of id4n

• routing.getAllRoutes

  Retrieve all routes of a GUID (or ID4N)

• routing.getRoute

  Retrieve current route of a GUID (or ID4N)

• routing.getRoutingFile

  Retrieve routing file

• routing.updateRoutingFile

  Store routing file

• storage.createDocument

  The documents' mime type is suggested on octet-stream data. Otherwise the specified content mime type is used.

• storage.deleteDocument

  Delete a document

• storage.getDocument

  Retrieve a document (meta-data only, no content)

• storage.listAllDocuments

  Listing all documents of an id4n

• storage.listDocuments

  Listing documents of an id4n seen by a specified organization

• storage.putDocument

  Creating or overwriting an existing document

• storage.readDocument

  Read document contents

• storage.readFromMicrostorage

  Read data from microstorage

• storage.updateDocumentMetadata

  Update a document

• storage.writeToMicrostorage

  Write data to microstorage

• transfer.getSendInfo

  Show transfer preparation information

• transfer.prepare

  Prepare an object for transfer

• transfer.receive

  Taking ownership can be forbidden by a previous owner. See methods prepare and getInfo

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools