syncOperationStatus()

This method retrieves the latest status of the asynchronously exported project based on the provided input JSON.

The syncOperationStatus function accepts a JSON string (inputJson) with search criteria for determining the status of an asynchronously exported project. It returns the most recent status based on the criteria specified.

String syncOperationStatus(String inputJson)

Input Parameters

• inputJson — search criteria for determining the status of an asynchronously exported project:
  • containerIdentifier — The container's unique identifier is used to retrieve the status.
  • operationStatus — The supported statuses are Successful, Failed, Started, and Queued. If no status is specified, it will retrieve all statuses.
  • userId — The ID of the user who performed the asynchronous operation. If not specified, it retrieves the status for all users.

By adding values into the search criteria in the inputJson file, the status may be obtained as required.

Use Case 1

A container with containerIdentifier as AsyncProject01 and status as Successful is requested.

{
  "SearchCriterias": [
    {
      "containerIdentifier": "AsyncProject01",
      "tcContainerIdentifier": "",
      "operationStatus": "Successful",
      "userId": ""
    }
  ]
}

Use case 2

All the containers with the status as Failed are requested.

{
  "SearchCriterias": [
    {
      "containerIdentifier": "",
      "tcContainerIdentifier": "",
      "operationStatus": "Failed",
      "userId": ""
    }
  ]
}

Use case 3

The inputJson is empty. All the exported or updated containers with all statuses are retrieved.

Returns

A JSON string representing the status of the requested containers.

Output format

The JSON file from the syncOperationStatus response provides the following information for each requested container: container identifier, Teamcenter container identifier, error status, start time, end time, user ID, and operation status.

{
    "Projects": " ",
    "Containers": [
        {
            "containerIdentifier": "Project_1",
            "tcContainerIdentifier": " QgldvfTyJvZBlD",
            "attribute": [
                { "attrName": "operationStatus", "value": "Successful" },
                { "attrName": "error", "value": "" },
                { "attrName": "start_time", "value": "16-Apr-2025 16:16" },
                { "attrName": "endTime", "value": "16-Apr-2025 16:18" },
                { "attrName": "userId", "value": "demo (demo)" }
            ]
        }
    ]
}