Canvas Notes

List Flow Version Notes

get

Retrieves a list of notes on the canvas for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/notes

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/notes HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Create Flow Version Note

post

Creates a new note on the canvas for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/flow-versions/{flow_version}/notes

HTTPcURLJavaScriptPython

POST /api/v1/flow-versions/{flow_version}/notes HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Get Flow Version Note

get

Retrieves the details of a specific canvas note for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

get

/api/v1/flow-versions/{flow_version}/notes/{note}

HTTPcURLJavaScriptPython

GET /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Update Flow Version Note

put

Updates an existing canvas note for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/flow-versions/{flow_version}/notes/{note}

HTTPcURLJavaScriptPython

PUT /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content

Delete Flow Version Note

delete

Permanently deletes a specific canvas note for a specific flow version.

Authorizations

ApiKeyAuthBearerAuth

AuthorizationstringRequired

API key passed in the Authorization header. Format: <api-key>

Path parameters

flow_versionstringRequired

The flow version identifier.

notestringRequired

The note identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

delete

/api/v1/flow-versions/{flow_version}/notes/{note}

HTTPcURLJavaScriptPython

DELETE /api/v1/flow-versions/{flow_version}/notes/{note} HTTP/1.1
Host: core.wearepatchworks.com
Authorization: YOUR_API_KEY
Accept: */*

No content