Comments
API | Description |
---|---|
POST v1/{subscriptionID}/projects/{projectID}/diagram/nodes/{diagramNodeID}/comments |
Creates a new comment to a diagram node or as a reply to a comment. |
GET v1/{subscriptionID}/projects/{projectID}/diagram/nodes/{diagramNodeID}/comments |
Gets all comments for a diagram node. |
PUT v1/{subscriptionID}/comments/{commentID}/read |
Gets a startup project including its diagram for a user in a subscription. |
DataSources
API | Description |
---|---|
GET v1/{subscriptionID}/dataSources/{dataSourceID} |
Gets a data source. |
GET v1/{subscriptionID}/projects/{projectID}/dataSources |
Gets all data sources in a project. |
DELETE v1/{subscriptionID}/dataSources/{dataSourceID} |
Deletes a data source. |
GET v1/{subscriptionID}/dataSources/{dataSourceID}/schema |
Gets a data source schema. |
POST v1/{subscriptionID}/projects/{projectID}/dataSources/async |
Creates a new data source. |
GET v1/{subscriptionID}/projects/{projectID}/dataSources/async/result |
Gets a result of a data source creation. |
Documents
API | Description |
---|---|
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
API | Description |
---|---|
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
API | Description |
---|---|
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. |
ProjectParameters
API | Description |
---|---|
PUT v1/{subscriptionID}/projects/parameters/{parameterID} |
Updates a project parameter. |
GET v1/{subscriptionID}/projects/parameters/{parameterID} |
Gets a project parameter. |
GET v1/{subscriptionID}/projects/{projectID}/parameters |
Gets all project parameters of a project. |
Projects
Runs
API | Description |
---|---|
GET v1/{subscriptionID}/runs/{runID} |
Gets a run. |
GET v1/{subscriptionID}/touchPoints/{touchPointID}/lastRun |
Gets a last run in a touchpoint. |
System
API | Description |
---|---|
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. |
GET v1/system/subscriptions |
Gets all subscriptions. |
TouchPoints
API | Description |
---|---|
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. |
POST v1/{subscriptionID}/touchPoints/{touchPointID}/preview |
Previews a touchpoint by a recipient key. |
POST v1/{subscriptionID}/touchPoints/{touchPointID}/preview/byRecipientIndex |
Previews a touchpoint by a recipient index. |
PUT v1/{subscriptionID}/touchPoints/{touchPointID}/type |
Changes a touchpoint's type. |
POST v1/{subscriptionID}/touchPoints/{touchPointID}/duplicate |
Duplicates a touchpoint. |