REST API V2 Enhancements and Changes

New REST API V2 Client

The new REST API V2 Client simplifies developer interaction with the REST API V2. Refer to the 'REST API V2 Client Guide' for details on adding and using the client, calling the API, integrating with the Modular Service Platform (introduced in Update 2025.3), and error handling.

New and updated endpoints

REST API V2 is now updated to version 1.4.0 and includes expanded and new endpoints. For parameters and property details on each endpoint, refer to its description and associated schemas in the Swagger UI.

These existing endpoints now include the new properties listed:

• GET /attributes/{id} - the validForObjectTypes and validator properties

• GET /list-of-values/{id} - the validator property

• GET /list-of-values/{id} - the dataTypeGroups property

• GET /data-container-types/{id} - the dataTypeGroups, validForObjectTypes, inherited, hierarchyRestricted, validAttributes, validReferenceTypes, keyAttributes, and keyReferenceTypes properties

• GET /reference-types/{id} - the validAttributes, dataTypeGroups, inheritable, accumulativelyInheritable, and validSourceDataContainerTypes properties

• GET /units/{id} - the unitGroup property

Existing endpoints that receive or return Single Value and Multi Value have been expanded to include the new simpleValue property. This improvement applies to all GET, POST, and PATCH endpoints.

Data type group resources (commonly called 'attribute groups') are available with the following new endpoints:

• GET /data-type-groups/{id}/attributes

• GET /data-type-groups/{id}/reference-types - also includes link types

• GET /data-type-groups/{id}/children

• GET /data-type-groups/{id}/datacontainer-types

These new endpoints return a deduplicated, unsorted array of IDs for the specified element in or below the data type group.

System information resources are available with the following new endpoint:

• GET /system-information/{id}

This endpoint returns customer name and system name.

Context information is available with the following new endpoints:

• GET /contexts

• GET /contexts/{id}

These endpoints return the list of context IDs and the details for a specified context.

Unique key resources are available with the following new endpoint:

• GET /unique-keys/{id}

This endpoint returns applicable object types for the key, key attributes, the key formula, and metadata.

Parent object type IDs are now accessible using the updated object-types endpoint and children object types IDs are accessible with a new endpoint:

• GET /object-types/{id}

• GET /object-types/{id}/children

Collections can be created and managed using the following new endpoints:

• POST /collections/ - Creates a new collection object with an autogenerated ID containing the provided list of object STEP URLs.

• PUT /collections/{id} - Creates or replaces a collection with a known ID to include contents based on the provided list of object STEP URLs.

• GET /collections/{id}

• GET /collections/{id}/content - Returns the contents of a collection as a list of object STEP URLs.

• DELETE /collections/{id}

Information about collection groups is accessible using the following new endpoints:

• GET /collection-groups/{id}

• GET /collection-groups/{id}/children

• GET /collection-groups/{id}/collections

New batching functionality

Multiple REST operations can be executed in a single request with the new POST /batch/execute endpoint.

Refer to the Technical Documentation, available at [URL]/sdk or accessible from the Start Page for prerequisites, transactional modes, and limits.

Access to original data files

Additionally, files that are imported into STEP using Import Manager in workbench and Simple Import Widget in Web UI are now included as an attachment on the background process (BGP). This aligns with the existing BGP functionality for inbound integration endpoints (IIEPs). For imports, the 'originalAttachmentId' returned by the REST call is INPUTFILE.

Files that are exported from STEP are saved as an attachment on the BGP, now including when the delivery fails, or when the file is quarantined. For exports, the 'originalAttachmentId' returned by the REST call is OUTPUTFILE.

To access an original data file, use the following:

• GET /background-processes/{id}/attachments

• GET /background-processes/{id}/attachments/{attachmentId}

• GET /background-processes/{id}/attachments/{attachmentId}/content