Comments

Comments controller.

APIDescription
POST v1/{subscriptionID}/projects/{projectID}/diagram/nodes/{diagramNodeID}/comments?replyToCommentID={replyToCommentID}

Creates a new comment to diagram node or as a reply to root comment.

GET v1/{subscriptionID}/projects/{projectID}/diagram/nodes/{diagramNodeID}/comments

Gets all comments for a node in diagram.

PUT v1/{subscriptionID}/comments/{commentID}/read?commentRead={commentRead}

Gets a startup project including its diagram for a user in a subscription.

Documents

Documents controller.

APIDescription
GET v1/{subscriptionID}/documents/{documentID}

Gets a document.

GET v1/{subscriptionID}/projects/{projectID}/documents

Gets all documents in a project.

DELETE v1/{subscriptionID}/documents/{documentID}

Deletes a document.

FilteredLists

Filtered lists controller.

APIDescription
GET v1/{subscriptionID}/filteredLists/{filteredListID}

Gets a filtered list.

GET v1/{subscriptionID}/projects/{projectID}/filteredLists

Gets all filtered lists in a project.

POST v1/{subscriptionID}/projects/{projectID}/filteredLists

Creates a new filtered list.

PUT v1/{subscriptionID}/filteredLists/{filteredListID}

Updates a filtered list.

DELETE v1/{subscriptionID}/filteredLists/{filteredListID}

Deletes a filtered list.

MasterLists

Master lists controller.

APIDescription
GET v1/{subscriptionID}/projects/{projectID}/masterList

Gets a master list associated with a specified project ID.

POST v1/{subscriptionID}/projects/{projectID}/masterList

Creates a new master list and associates it with a specified project ID.

PUT v1/{subscriptionID}/projects/{projectID}/masterList

Updates a specific master list associated with a specified project ID.

DELETE v1/{subscriptionID}/projects/{projectID}/masterList

Deletes a master list associated with a specified project ID.

Projects

Projects controller.

APIDescription
GET v1/{subscriptionID}/projects/{projectID}

Gets a project.

GET v1/{subscriptionID}/projects?types[0]={types[0]}&types[1]={types[1]}&statuses[0]={statuses[0]}&statuses[1]={statuses[1]}&automationModes[0]={automationModes[0]}&automationModes[1]={automationModes[1]}&bindingTypes[0]={bindingTypes[0]}&bindingTypes[1]={bindingTypes[1]}&page={page}&pageSize={pageSize}&sortBy={sortBy}&sortOrder={sortOrder}&familyID={familyID}&modifierID={modifierID}&search={search}

Gets all projects for a user in a subscription.

POST v1/{subscriptionID}/projects

Creates a new project.

PUT v1/{subscriptionID}/projects/{projectID}

Updates a project.

DELETE v1/{subscriptionID}/projects/{projectID}?force={force}

Deletes a project.

POST v1/{subscriptionID}/projects/{projectID}/archive?force={force}

Archives a project.

POST v1/{subscriptionID}/projects/{projectID}/archive/restore

Restores a project from the archive.

POST v1/{subscriptionID}/projects/{projectID}/automation/start?resetStartDateTime={resetStartDateTime}

Starts automation for a project.

POST v1/{subscriptionID}/projects/{projectID}/automation/stop

Stops automation for a project.

DELETE v1/{subscriptionID}/projects/{projectID}/webSecurityToken

Revokes a web security token and returns a new one.

GET v1/{subscriptionID}/projects/{projectID}/singleSignOnUrl?pageName={pageName}&pageParameter={pageParameter}

Gets a single sign-on URL.

Runs

Runs controller.

APIDescription
GET v1/{subscriptionID}/runs/{runID}

Gets a run.

GET v1/{subscriptionID}/touchPoints/{touchPointID}/lastRun

Gets a last run in a touchpoint.

System

System controller.

APIDescription
POST v1/system/login

Log ins to Circle. Generates a new security token.

POST v1/system/logout

Logs out from Circle. Releases a security token.

POST v1/system/renewlogin

Renews Circle login and a security token.

TouchPoints

Touchpoints controller.

APIDescription
GET v1/{subscriptionID}/touchPoints/{touchPointID}

Gets a touchpoint.

GET v1/{subscriptionID}/projects/{projectID}/touchPoints

Gets all touchpoints in a project.

POST v1/{subscriptionID}/projects/{projectID}/touchPoints

Creates a new touchpoint.

PUT v1/{subscriptionID}/touchPoints/{touchPointID}

Updates a touchpoint.

DELETE v1/{subscriptionID}/touchPoints/{touchPointID}

Deletes a touchpoint.

POST v1/{subscriptionID}/touchPoints/{touchPointID}/process

Processes a touchpoint.

POST v1/{subscriptionID}/touchPoints/{touchPointID}/test

Tests a touchpoint.