Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

ListSyncResources

Lists the sync resources.

Request Syntax


POST /workspaces/workspaceId/sync-jobs/syncSource/resources-list HTTP/1.1
Content-type: application/json

{
   "filters": [ 
      { ... }
   ],
   "maxResults": number,
   "nextToken": "string"
}

URI Request Parameters

The request uses the following URI parameters.

syncSource

The sync source.

Note

Currently the only supported syncSource is SITEWISE .

Pattern: [a-zA-Z_0-9]+

Required: Yes

workspaceId

The ID of the workspace that contains the sync job.

Length Constraints: Minimum length of 1. Maximum length of 128.

Pattern: [a-zA-Z_0-9][a-zA-Z_\-0-9]*[a-zA-Z0-9]+

Required: Yes

Request Body

The request accepts the following data in JSON format.

filters

A list of objects that filter the request.

The following filter combinations are supported:

Filter with state
Filter with ResourceType and ResourceId
Filter with ResourceType and ExternalId

Type: Array of SyncResourceFilter objects

Required: No

maxResults

The maximum number of results to return at one time. The default is 50.

Valid Range: Minimum value of 0. Maximum value of 200.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 200.

Required: No

nextToken

The string that specifies the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 17880.

Pattern: .*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextToken": "string",
   "syncResources": [ 
      { 
         "externalId": "string",
         "resourceId": "string",
         "resourceType": "string",
         "status": { 
            "error": { 
               "code": "string",
               "message": "string"
            },
            "state": "string"
         },
         "updateDateTime": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

nextToken

The string that specifies the next page of results.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 17880.

Pattern: .*

syncResources

The sync resources.

Type: Array of SyncResourceSummary objects

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

Access is denied.

HTTP Status Code: 403

InternalServerException

An unexpected error has occurred.

HTTP Status Code: 500

ServiceQuotaExceededException

The service quota was exceeded.

HTTP Status Code: 402

ThrottlingException

The rate exceeds the limit.

HTTP Status Code: 429

ValidationException

Failed

HTTP Status Code: 400