{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/trimble/json-schema/trimble-sync-object-list-schema.json",
  "title": "SyncObjectList",
  "description": "The list of objects with changeToken",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/trimble-connect-topics-openapi.yml#/components/schemas/SyncObjectList",
  "type": "object",
  "required": [
    "links"
  ],
  "properties": {
    "changeToken": {
      "type": "string",
      "description": "The new cursor value for subsequent fetches. When the same requested cursor value is returned in the response, it indicates that no objects of the specified type have been created in the project yet. In this scenario, retrying the same API later is necessary to check for any newly created objects."
    },
    "items": {
      "description": "The objects changed since the last changeToken. This may be empty if there are no changes since the last changeToken.",
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/TopicList"
        },
        {
          "$ref": "#/$defs/CommentList"
        },
        {
          "$ref": "#/$defs/ViewpointList"
        },
        {
          "$ref": "#/$defs/DocumentReferenceList"
        }
      ]
    },
    "deletedItems": {
      "description": "The objects deleted since the last changeToken. This may be empty if there are no deletions since the last changeToken.",
      "type": "object",
      "oneOf": [
        {
          "$ref": "#/$defs/DeletedTopicList"
        },
        {
          "$ref": "#/$defs/DeletedCommentList"
        },
        {
          "$ref": "#/$defs/DeletedViewpointList"
        },
        {
          "$ref": "#/$defs/DeletedDocumentReferenceList"
        }
      ]
    },
    "links": {
      "$ref": "#/$defs/PageLinks"
    }
  },
  "$defs": {
    "AssigneeDto": {
      "type": "object",
      "required": [
        "id"
      ],
      "properties": {
        "id": {
          "type": "string",
          "description": "The Trimble Connect Id of the assignee."
        },
        "type": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "BimSnippetDto": {
      "type": "object",
      "required": [
        "snippet_type",
        "is_external",
        "reference",
        "reference_schema"
      ],
      "properties": {
        "snippet_type": {
          "type": [
            "string",
            "null"
          ]
        },
        "is_external": {
          "type": [
            "boolean",
            "null"
          ]
        },
        "reference": {
          "type": [
            "string",
            "null"
          ]
        },
        "reference_schema": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "CommentDto": {
      "type": "object",
      "required": [
        "guid",
        "date",
        "author",
        "author_uuid",
        "comment",
        "topic_guid"
      ],
      "properties": {
        "version": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32",
          "minimum": 0
        },
        "guid": {
          "type": "string"
        },
        "date": {
          "type": "string",
          "format": "date-time"
        },
        "author": {
          "type": "string"
        },
        "author_uuid": {
          "type": "string"
        },
        "created_by_uuid": {
          "type": [
            "string",
            "null"
          ]
        },
        "comment": {
          "type": "string"
        },
        "topic_guid": {
          "type": "string"
        },
        "viewpoint_guid": {
          "type": [
            "string",
            "null"
          ]
        },
        "viewpoint": {
          "$ref": "#/$defs/ViewpointInfoDto"
        },
        "reply_to_comment_guid": {
          "type": [
            "string",
            "null"
          ]
        },
        "modified_date": {
          "type": "string",
          "format": "date-time"
        },
        "modified_author": {
          "type": [
            "string",
            "null"
          ]
        },
        "modified_author_uuid": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "CommentList": {
      "type": "object",
      "required": [
        "comments"
      ],
      "properties": {
        "comments": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/CommentDto"
          }
        }
      }
    },
    "DeletedCommentList": {
      "type": "object",
      "required": [
        "comments"
      ],
      "properties": {
        "comments": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SubresourceReference"
          }
        }
      }
    },
    "DeletedDocumentReferenceList": {
      "type": "object",
      "required": [
        "documentReferences"
      ],
      "properties": {
        "documentReferences": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SubresourceReference"
          }
        }
      }
    },
    "DeletedTopicList": {
      "type": "object",
      "required": [
        "topics"
      ],
      "properties": {
        "topics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TopicReference"
          }
        }
      }
    },
    "DeletedViewpointList": {
      "type": "object",
      "required": [
        "viewPoints"
      ],
      "properties": {
        "viewPoints": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/SubresourceReference"
          }
        }
      }
    },
    "DocumentReferenceList": {
      "type": "object",
      "required": [
        "documentReferences"
      ],
      "properties": {
        "documentReferences": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/DocumentReferenceWithTopicReferenceDto"
          }
        }
      }
    },
    "DocumentReferenceWithTopicReferenceDto": {
      "type": "object",
      "required": [
        "guid",
        "topic_guid"
      ],
      "properties": {
        "guid": {
          "type": "string"
        },
        "topic_guid": {
          "type": "string"
        },
        "version": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "document_guid": {
          "type": [
            "string",
            "null"
          ]
        },
        "url": {
          "type": [
            "string",
            "null"
          ],
          "description": "Note that this property should be named `referenced_document` according to the [BCF standard v2.1](https://github.com/BuildingSMART/BCF-API/tree/v2.1#47-document-reference-services). However it is named `url` to match the new naming introduced in the [BCF standard v3.0](https://github.com/buildingSMART/BCF-API#37-document-reference-services)."
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "created_by_uuid": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": [
            "string",
            "null"
          ],
          "readOnly": true
        }
      },
      "additionalProperties": false
    },
    "FileDto": {
      "type": "object",
      "properties": {
        "ifc_project": {
          "type": [
            "string",
            "null"
          ]
        },
        "ifc_spatial_structure_element": {
          "type": [
            "string",
            "null"
          ]
        },
        "file_name": {
          "type": [
            "string",
            "null"
          ]
        },
        "date": {
          "type": [
            "string",
            "null"
          ]
        },
        "reference": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "MarkerDto": {
      "type": "object",
      "properties": {
        "model_point": {
          "$ref": "#/$defs/PointDto"
        }
      },
      "additionalProperties": false
    },
    "PageLinks": {
      "type": "object",
      "required": [
        "self",
        "first"
      ],
      "properties": {
        "self": {
          "type": "object",
          "description": "A URL that will retrieve the response that was just received.",
          "properties": {
            "href": {
              "type": "string",
              "description": "An absolute or relative url."
            }
          }
        },
        "first": {
          "type": "object",
          "description": "A URL that will retrieve the first page of results.",
          "properties": {
            "href": {
              "type": "string",
              "description": "An absolute or relative url."
            }
          }
        },
        "next": {
          "type": "object",
          "description": "A URL that will retrieve the next page of results. Responses that include only a partial set of the items identified by the request will contain a link that allows retrieving the next partial set of items. \r\n\r\n This link is called a next link. Clients should treat the URL of the next link as opaque, and should not append system query options to the URL of a next link. \r\n\r\n The url returned by server might be an absolute url or path with query parameters. \r\n\r\n If it is a path, client is responsible for adding a hostname to form a full url. \r\n\r\n Otherwise no transformations must be applied by the client to the url and it should be sent as is to the server to fetch the next page of events.",
          "properties": {
            "href": {
              "type": "string",
              "description": "An absolute or relative url."
            }
          }
        }
      }
    },
    "PointDto": {
      "type": "object",
      "required": [
        "x",
        "y"
      ],
      "properties": {
        "x": {
          "type": "number",
          "format": "double"
        },
        "y": {
          "type": "number",
          "format": "double"
        },
        "z": {
          "type": "number",
          "format": "double"
        }
      },
      "additionalProperties": false
    },
    "RelatedTopicDto": {
      "type": "object",
      "required": [
        "related_topic_guid"
      ],
      "properties": {
        "related_topic_guid": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "SubresourceReference": {
      "type": "object",
      "required": [
        "guid",
        "topic_guid"
      ],
      "properties": {
        "guid": {
          "type": "string"
        },
        "topic_guid": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "TopicDto": {
      "type": "object",
      "required": [
        "guid",
        "title",
        "creation_date",
        "creation_author",
        "creation_author_uuid"
      ],
      "properties": {
        "version": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32",
          "minimum": 0
        },
        "guid": {
          "type": "string"
        },
        "topic_type": {
          "type": [
            "string",
            "null"
          ]
        },
        "topic_status": {
          "type": [
            "string",
            "null"
          ]
        },
        "reference_links": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "title": {
          "type": "string"
        },
        "priority": {
          "type": [
            "string",
            "null"
          ]
        },
        "index": {
          "type": [
            "integer",
            "null"
          ],
          "format": "int32"
        },
        "labels": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "string"
          }
        },
        "creation_date": {
          "type": "string",
          "format": "date-time"
        },
        "creation_author": {
          "type": "string"
        },
        "creation_author_uuid": {
          "type": "string"
        },
        "created_by_uuid": {
          "type": [
            "string",
            "null"
          ]
        },
        "modified_date": {
          "type": "string",
          "format": "date-time"
        },
        "modified_author": {
          "type": [
            "string",
            "null"
          ]
        },
        "modified_author_uuid": {
          "type": [
            "string",
            "null"
          ]
        },
        "assigned_to": {
          "type": [
            "string",
            "null"
          ]
        },
        "assigned_to_uuid": {
          "type": [
            "string",
            "null"
          ]
        },
        "assignees": {
          "description": "The `assignees` is a Connect-specific extension of the `assigned_to` property specified by the BCF standard, making it possible to have multiple assignees. Note that when both `assignees` and `assigned_to` are set in the request body, `assignees` will override `assigned_to`.",
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/AssigneeDto"
          }
        },
        "stage": {
          "type": [
            "string",
            "null"
          ]
        },
        "description": {
          "type": [
            "string",
            "null"
          ]
        },
        "due_date": {
          "type": [
            "string",
            "null"
          ],
          "format": "date-time"
        },
        "marker": {
          "$ref": "#/$defs/MarkerDto"
        },
        "viewpoint": {
          "$ref": "#/$defs/ViewpointInfoDto"
        },
        "bim_snippet": {
          "$ref": "#/$defs/BimSnippetDto"
        },
        "related_topics": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/RelatedTopicDto"
          }
        },
        "files": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "$ref": "#/$defs/FileDto"
          }
        }
      },
      "additionalProperties": false
    },
    "TopicList": {
      "type": "object",
      "required": [
        "topics"
      ],
      "properties": {
        "topics": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/TopicDto"
          }
        }
      }
    },
    "TopicReference": {
      "type": "object",
      "required": [
        "guid"
      ],
      "properties": {
        "guid": {
          "type": "string"
        }
      },
      "additionalProperties": false
    },
    "ViewpointInfoDto": {
      "type": "object",
      "properties": {
        "guid": {
          "type": [
            "string",
            "null"
          ]
        },
        "view_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "snapshot_url": {
          "type": [
            "string",
            "null"
          ]
        },
        "snapshot_thumb": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    },
    "ViewpointList": {
      "type": "object",
      "required": [
        "viewPoints"
      ],
      "properties": {
        "viewPoints": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ViewpointWithTopicReferenceDto"
          }
        }
      }
    },
    "ViewpointWithTopicReferenceDto": {
      "type": "object",
      "required": [
        "guid",
        "topic_guid"
      ],
      "properties": {
        "guid": {
          "type": "string"
        },
        "topic_guid": {
          "type": "string"
        },
        "view_id": {
          "type": [
            "string",
            "null"
          ]
        },
        "snapshot_url": {
          "type": [
            "string",
            "null"
          ]
        },
        "snapshot_thumb": {
          "type": [
            "string",
            "null"
          ]
        }
      },
      "additionalProperties": false
    }
  }
}