IDs on the Platform

The Akana API Platform uses a number of unique identifiers to identify different resources and other objects commonly referenced on the platform, such as apps, APIs, tickets, discussions, users, reviews, notifications, and many others.

These IDs are assigned by the back end, and are essentially simple strings. However, they generally have a two-part construction, such as:

  • {uniqueid for object/tenant}.{tenant name}

For example, a unique UserID for a user on Akana API Platform might be eceffbe3-3386-495b-80d3-7526f0eb0edc.acmepaymentscorp. In this example:

  • eceffbe3-3386-495b-80d3-7526f0eb0edc is unique to Akana API Platform, so the unique user record can be located in the Akana API Platform database.
  • acmepaymentscorp indicates the tenant name. Including the tenant name after the period increases the usefulness of the object, because even if two tenants both have a user eceffbe3-3386-495b-80d3-7526f0eb0edc, each ID is unique across the entirety of the platform in a federated scenario where there might be many tenants.

Back to top

ID Types

The table below lists ID types used on the platform, with examples.

Name Description Example
ActionID The unique ID for a specific workflow action.  
AdminGroupID The unique ID for the Admin Group associated with a specific resource, such as an API or business, comprised of all administrators associated with that resource. Only used in response messages. group18970.acmepaymentscorp
AdminGroupRecipientObjectID The unique ID for a user group whose members will receive a specific notification.  
AgreementID The unique ID for a specific legal agreement associated with an API.  
AgreementScopeID

The unique ID for the scope of a legal agreement.

In the case of an API access request, the AgreementScopeID is the AppVersionID. When an app version is connecting to an API version, the app developer must accept any legal agreements configured for the specific API version and the agreements configured for licenses that are part of the scope of the API contract being set up.

 
AlertID The unique ID for a specific alert. alert11639.acmepaymentscorp
APIID The unique ID for a specific API. 8bebe599-3b97-45bc-a6a7-73542af275a7.acmepaymentscorp
APIVersionID The unique ID for a specific API version. 48692e9f-f452-4a17-b793-5368b1b116c3.acmepaymentscorp
AppID The unique ID for a specific app. app10021.acmepaymentscorp
AppRuntimeID

Unique ID used at runtime by the app version.

Note: The RuntimeID for an app and the AppVersionID are essentially the same, but the values are reversed.

acmepaymentscorp.72zNE5InKlf2z00y8fWSp3AU
AppVersionID

The unique ID for a specific app version.

The App Version ID is made up of two elements, separated by a dot: an RDN, which is a 24-character hex value randomly generated when the version is created, and the FedmemberID (tenant name).

Note: RuntimeID AppVersionID are the same value. When this appears in a form parameter, the API uses AppVersionID; when it's part of a request or response object, the API uses RuntimeID.

72zNE5InKlf2z00y8fWSp3AU.acmepaymentscorp
AppVersionDN Same as AppVersionID, see above. 72zNE5InKlf2z00y8fWSp3AU.acmepaymentscorp
AssetID The unique AssetID for a resource; could be the UDDI key of a service.  
AuthorID The unique UserID for the author of a resource such as a discussion.  
AvatarVersionID The unique ID for a specific version of an avatar. Each time an avatar is assigned to a resource such as an app or API, the platform assigns a unique ID to the avatar. If a different avatar is then assigned to the same resource, the new avatar has a different AvatarID. b49540e4-a45e-4186-807f-a4e74d94fd83.png
BoardID

The unique ID for a specific forum (board), such as an app, API, or group forum or a user-defined forum.

In the Boards service, operations that use the BoardID are generally for user-defined boards.

 
BoardItemID

The unique ID for a specific Board item. For example, if it is an API board, it is the APIID.

In the Boards service, operations that use the BoardItemID can generally be used for any time of board.

To get the Board Item ID, if necessary, you can use the following operations:

 
BusinessAdminGroupID

The unique GroupID for the Business Admin group on the platform.

To find out what the BusinessAdminGroupID is for your business, you can run the GET /api/properties operation.

 
BusinessID

The unique ID for a specific business organization on the platform.

When the tenant is configured, as part of the post-install configuration with the jython script, a business is created, and has a unique Business ID. Currently, each tenant can have only one business configured.

To find out what the Business ID is for your installation, you can run the GET /api/properties operation. It is the TenantBusinessID value.
tenantbusiness.acmepaymentscorp
BusinessKey A unique ID used by the underlying infrastructure to identify a business. Most operations use the BusinessID, which is made up of a unique ID for the tenant and the tenant ID. However, some operations that reference the features of the underlying infrastructure use the BusinessKey, which is a globally unique ID assigned to the business by the underlying infrastructure. The BusinessKey doesn't indicate the tenant. These two IDs are completely separate, and each business organization has both.  
ClientID The unique ID for a specific OAuth client, as set up with the OAuth Provider. In the context of the platform, the ClientID is the same as the app's RuntimeID. acmepaymentscorp-9ezRSOnifci8EYNndZu79U6w.
CommentID

The unique ID for a specific comment.

In the Boards service, operations that take the CommentID as a path parameter can generally be used for any time of board.

3a7e2509-0474-4938-8bcd-2aee1d9ecae1.acmepaymentscorp

1039801c-27fc-45cf-ae80-09990fc321f9

CommentSubjectID The unique ID for a specific comment subject. discussion10550.acmepaymentscorp
ContextObjectID The unique ID of the object that a group belongs to, if applicable. For an app team it is the AppID; for an API Scope Group it is the APIVersionID.  
ContractID

The unique ID for a specific contract between an app version and an API version.

Note: ContractID and APIAccessRequest are synonymous.

contract17172.acmepaymentscorp
DefaultVersionID Unique ID for the latest or only version of an app.  
DeploymentZoneID Unique ID for a specific deployment zone. (DeploymentZoneID and DZoneID are the same.)  
DiscussionID The unique ID for a specific discussion. 063fe661-a74f-40d2-a242-9d49ec426e81.acmepaymentscorp
DiscussionSubjectID The unique ID for the specific resource that a discussion relates to; for example, the AppVersionID, APIVersionID, GroupID, or a custom BoardID. apiversion20693.acmepaymentscorp, 4iXro2Uxs2h4LviCshR9pK9w.acmepaymentscorp
DocumentID Same as LegalDocumentID.  
DomainID The unique ID for the domain relating to OAuth implementation. Used in the OAuth services and the Login API. 1006
DropboxFileId

A temporary ID for an API description document file uploaded to the platform. The DropboxFileId is assigned by the Dropbox when the file is first uploaded to the platform, using the Dropbox service, as part of adding or updating the resource.

Note: Most IDs are strings but DropboxFileId and PictureId have a data type of long.

 
DropboxId

A temporary ID for a file uploaded to the platform. The DropboxId is assigned by the Dropbox when the file is first uploaded to the platform, using the Dropbox service, as part of adding or updating the resource.

Note: Most IDs are strings, but DropboxId and PictureId have a data type of long.

1021
DZoneID Unique ID for a specific deployment zone. (DeploymentZoneID and DZoneID are the same.)  
FedMemberID

The unique ID for a specific federation member.

The FedMemberID is the last part of most IDs. In most of the examples in this table, 

acmepaymentscorp is the FedMemberID.
Tenant01, acmepaymentscorp
FollowedID The unique identifier for a resource that is being followed by an individual.  
FollowingID The unique ID for a "following" relationship between a user and a specific resource the user is following (app or API). follow15927.acmepaymentscorp
GrantID The unique ID for a specific instance of an OAuth grant.  
GroupID The unique ID for a specific group. apiadmin-73691c5e-598a-4251-aac2-2a5b28385207.acmepaymentscorp
GroupMembershipID The unique ID for a specific user's membership in a specific group.  
ItemID The unique ID for a specific forum entry.  
ID

Some operations are shared between multiple resources. An example is the "get rating" operation, used by the apps, apis, and groups services. In the apps service it is GET /api/apps/versions/{AppVersionID}/ratings/{UserID}; in the APIs service it is GET /api/versions/{APIVersionID}/ratings/{UserID}/ratings.

These shared operations take a URL parameter of {ID}; the type of ID depends on the service using the shared operation, as follows:

 
LatestVersionID The APIVersionID for the latest version of an API that's available to the requesting user. Depending on the user's permissions, this might be the actual latest version of the API; however, if the user doesn't have access permission for the latest version, but has access to one or more earlier versions, it will be the latest version the user has access to. apiversion13558.acmepaymentscorp
LegalDocumentID

The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform.

LegalDocumentID and DocumentID are the same.

f894c83d-9c7a-44cd-8138-47df88b47583.acmepaymentscorp
LicenseID The unique ID for a specific license. 759aa82d-aeb7-4fa0-8dd1-e62d7f38e858.acmepaymentscorp
LicenseTermID The unique ID for a specific license term.  
LoginDomainID The unique ID for a user's login domain; either the platform, for a local account, or an additional login domain such as Google or Facebook. The login domains supported by a specific platform version are configured by the Site Admin. siteusers.acmepaymentscorp
LogoID A unique ID assigned to a logo for a domain. For example, this is used in the LoginDomain object.  
LogoPictureID A unique Dropbox ID for the logo to be assigned on an app's public profile. 1553
MembershipRequestID The unique Board Item ID for a specific group membership request. group_member_req10034.acmepaymentscorp
NotificationID The unique ID for a specific instance of a notification on a specific user's Dashboard.  
NotificationSubjectID The unique ID for the association of a specific legal document with a resource such as an API version, license, or the platform. notification30170.acmepaymentscorp
OAuthClientID Unique ID for the OAuth Client.  
ObjectID The unique ID for a specific resource, such as an app, API, or user. Used by the Workflow service.  
ParentBusinessID The unique BusinessID for the parent organization (senior in the organization hierarchy) of a business organization on the platform.  
PictureId A temporary ID for a picture on the platform, such as the avatar for an app, API, or user. The PictureId is assigned by the Dropbox when the picture is first uploaded to the server, using the Dropbox service, as part of adding or updating the resource. PictureId is essentially the same as DropboxId. 1285
ProcessID A unique ID for a workflow process.  
ProviderId The ID of the third party providing validation for the user, such as Facebook® or Google®.  
ResourceID

The unique ID for a specific resource; for example, the ScopeID or the APIVersionID.

Usage examples:

The ResourceID could also be an AlertID, DiscussionID, TicketID, ReviewID, or CommentID.

user13967.acmepaymentscorp

5e0a3c2a-8afe-478d-a1dc-67772939d191.acmepaymentscorp

ResourceVersionKey

The unique ID for a version of a platform resource such as a UI resource.

The ResourceVersionKey changes when any files are uploaded to Resources or if any of the tenant settings are updated; App Settings, API Settings, Password Policy, etc. It is also updated if domain changes are made; for example, if a login domain is enabled or disabled. Because this key is part of the URL for platform resources, this means that cached versions of platform resources, with the old ResourceVersionKey value, will no longer be used; new versions of these resources will be retrieved.

After any change is made that causes an update of the ResourceVersionKey value, there is a 10-minute delay before the new key is available.

_VzCN6Wh5xIiOP5T8xLzuhJg
ResourceOwnerID The unique ID for the resource owner in the context of a specific OAuth transaction  
ReviewID The unique ID for a specific review. review24085.acmepaymentscorp
ReviewAuthorID The unique UserID for the author of a specific review. user23531.acmepaymentscorp
ReviewSubjectID The unique ID for the resource being reviewed; for example, an App ID. gbGPCs7Uvz4VV8D0Zuvzdq6C.acmepaymentscorp
RetrievingUserID The unique UserID of the user performing a specific action. eceffbe3-3386-495b-80d3-7526f0eb0edc.acmepaymentscorp
RuntimeID

The unique ID in the app's Runtime ID is the same as that in the AppVersionID. However, in some contexts, the Runtime ID has the format {platformID}-{Unique App ID} whereas the App ID has the format {Unique App ID}.{PlatformID}.

Note: Where RuntimeID appears in a request or response object, it is actually the AppVersionID.

acmepaymentscorp-9ezRSOnifci8EYNndZu79U6w.
ServiceID The unique ID for a specific proxied API service. Sometimes also called the ServiceKey. uddi:d26f2232-3bfe-11e7-8c53-f1aac8715c11
ScopeID A unique ID indicating the scope of a user's permissions.  
ScriptVersionKey

In general, resources in the developer portal use a unique ID in the URL, ResourceVersionKey, to indicate the version of a resource. This key is used to help manage caching. These resources can be cached for a month; however, if certain changes are made to the developer portal, such as changes in settings, the ResourceVersionKey is updated. Because resources using this key now have a new URL, new versions of the resources are retrieved.

Certain files in the platform, such as the production.js file, use a different key, ScriptVersionKey. This is only used for files when the file version will not change between releases. The ScriptVersionKey value is only updated when a new version of the platform is installed.

_VZDDEgXYVpd_dBFe6W7zNnQ
SiteAdminGroupID

The unique GroupID for the Site Admin group on the platform.

To find out what the SiteAdminGroupID is for your installation, you can run the GET /api/properties operation.

 
SourceID The unique ID assigned to the source of an RSS feed.  
StepID The unique ID for a workflow step.  
SubscriptionID The unique ID assigned to a tenant that has a subscription to the platform.  
TeamID The unique ID for the app team associated with the app.  
TenantBusinessID The unique ID for the tenant business; same as the BusinessID for the business. tenantbusiness.acmepaymentscorp
TenantID

Unique ID for a specific tenant, in a federation (multi-tenant) scenario.

To find out what the TenantID is for your installation, you can run the GET /api/properties operation.

acmepaymentscorp
TenantFedMemberID Same as TenantID. acmepaymentscorp
TicketID The unique ID for a specific ticket. ticket25687.acmepaymentscorp
TransactionID The unique ID for a specific transaction. f209d402-b406-11e2-a29e-c564ec007eb4
UserID The unique ID for a specific user. e437a7ea-108f-498e-9065-afd3776b2a08.acmepaymentscorp
ViewerID The unique ID of the viewer of a resource. This might be the unique ID of a viewer of a Discussion, Ticket, Alert, Review, or Comment; or it might be the GroupID of a group viewing an API. For example, the DELETE /api/apis/versions/{APIVersionID}/viewers/{ViewerID} operation has the ViewerID as an input parameter. apiadmin-73691c5e-598a-4251-aac2-2a5b28385207.acmepaymentscorp
VisibleToID A unique ID identifying the visibility of a Board item.  

Back to top

Related Topics