IDs on the Platform

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.

The unique ID for a specific app.

Note: The AppID field in the Community Manager developer portal is actually the AppRuntimeID, see below.

Unique ID used at runtime by the app version.

Note: By default, the RuntimeID for an app and the AppVersionID are essentially the same, but the values are reversed. In some cases, the RuntimeID can be user-defined. It is not case-sensitive and must be a unique set of alphanumeric characters.

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: AppRuntimeID and 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 AppRuntimeID.

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.

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:

• For an API: GET /api/apis/{APIID}/board
• For an API version: GET /api/apis/{APIVersionID}/board
• For an app: GET /api/apps/{AppID}/board
• For an app version: GET /api/apps/versions/{AppVersionID}/board
• For a group: GET /api/groups/{GroupID}/board
• For a board item on a user-defined board: GET /api/boards/{BoardID}/board

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.

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.

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.

In the API, OrgKey is sometimes used. OrgKey is the same as BusinessKey.

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

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

Note: ContractID and APIAccessRequest are synonymous.

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.

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.

Unique ID for a specific tenant. Same as TenantID.

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

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

Tenant01

The unique ID for a specific group.

If you're not sure of the ID for a specific group, and you're a member of the group yourself, you can run the GET /api/users/{UserID}/groups operation to get the IDs of groups you're a member of.

The Site Admin group name is: tenantadmin.{tenantid}. For example: tenantadmin.acmepaymentscorp.

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:

• In the apis service it is the APIVersionID
• In the apps service it is the AppVersionID
• In the groups service it is the GroupID
• In the users service it is the UserID

The ID for the latest version of a versioned resource that's available to the requesting user.

For example, for an API: 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.

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.

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

Usage examples:

• The GET /api/users/{UserID}/roles?ResourceID={ResourceID} operation references a UserID as a resource ID
• The GET /api/apis/versions/{APIVersionID}/resources response message references a ScopeID as a resourceID.

The ResourceID could also be the ID for another platform resource; for example, an AlertID, DiscussionID, TicketID, ReviewID, CommentID, or BusinessID.

user13967.acmepaymentscorp

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

tenantbusiness.acmepaymentscorp

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.

See AppRuntimeID.

In general, resources in the Community Manager 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 Community Manager 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.

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.

Unique ID for a specific tenant. Same as TenantID.

Note: The value normally used to identify a tenant is the FedmemberID.

The unique ID for a specific user.

Also called userFdn in some model objects.

The UserID is returned in the response to the POST /api/login operation (userFDN parameter in the response body). If you're a Site Admin you can also use the GET /api/search operation with user parameter (GET /api/search?q=type:user) to return a list of users.