Model Notes

Index

get

Pagination

Pagination is available for this request. Please see the section on using pagination for more details.

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• flowStep

• flowStep_count

• flowStepExists

• user

• user_count

• userExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• user_id

• my_notes

• model_type

• model_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• id

• created_at

Authorizations

ApiKeyAuth

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[my_notes]stringOptional

Filter results by my_notes.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowStep, user

sortstringOptional

Sort field. Prefix with - for descending. Available: id, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/model-notes

HTTPcURLJavaScriptPython

GET /api/v1/model-notes HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "note": "example_note",
      "private": "example_private",
      "patchworks_only": "example_patchworks_only",
      "model_type": "example_model_type",
      "model_id": 1,
      "colour": "blue",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "user_id": 1,
      "flow_step": {},
      "user": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/model-notes",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/model-notes?page=1",
    "last": "https://api.example.com/api/v1/model-notes?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
note	string	☑
private
patchworks_only
model_type	string	☑
model_id	integer	☑
colour	string	☑

Authorizations

ApiKeyAuth

Body

application/json

notestring · min: 1 · max: 65535Required

privatestringOptional

patchworks_onlystringOptional

model_typestringRequired

model_idintegerRequired

colourstring · enumRequiredPossible values:

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/model-notes

HTTPcURLJavaScriptPython

POST /api/v1/model-notes HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 158

{
  "note": "example_note",
  "private": "example_private",
  "patchworks_only": "example_patchworks_only",
  "model_type": "example_model_type",
  "model_id": 1,
  "colour": "blue"
}

{
  "data": {
    "id": 1,
    "note": "example_note",
    "private": "example_private",
    "patchworks_only": "example_patchworks_only",
    "model_type": "example_model_type",
    "model_id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "user_id": 1,
    "flow_step": {},
    "user": {}
  }
}

Show

get

Available Includes

These are the includes that can be used to include addition related data in the results. Please see the section on using includes for more details.

• flowStep

• flowStep_count

• flowStepExists

• user

• user_count

• userExists

Available Filters

These are the filters that can be used to specific the data to return. Please see the section on using filters for more details.

• user_id

• my_notes

• model_type

• model_id

Available Sorts

These are the sorts that can be used order the returned data. Please see the section on using sorting for more details.

• id

• created_at

Authorizations

ApiKeyAuth

Path parameters

model_notestringRequired

The model note identifier.

Query parameters

filter[user_id]stringOptional

Filter results by user_id.

filter[my_notes]stringOptional

Filter results by my_notes.

filter[model_type]stringOptional

Filter results by model_type.

filter[model_id]stringOptional

Filter results by model_id.

includestringOptional

Comma-separated list of relationships to include. Available: flowStep, user

sortstringOptional

Sort field. Prefix with - for descending. Available: id, created_at

pageinteger · min: 1Optional

Page number for pagination.

Default: 1

per_pageinteger · min: 1 · max: 100Optional

Number of results per page.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/model-notes/{model_note}

HTTPcURLJavaScriptPython

GET /api/v1/model-notes/{model_note} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "note": "example_note",
    "private": "example_private",
    "patchworks_only": "example_patchworks_only",
    "model_type": "example_model_type",
    "model_id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "user_id": 1,
    "flow_step": {},
    "user": {}
  }
}

Update

put

Validation Rules

These are the basic validation rules for the request. More detailed validation may apply depending on the data being sent. Please see the response for any extra requirements

Field	Type	Required
note	string
private
patchworks_only
colour	string

Authorizations

ApiKeyAuth

Path parameters

model_notestringRequired

The model note identifier.

Body

application/json

notestring · min: 1 · max: 65535Optional

privatestringOptional

patchworks_onlystringOptional

colourstring · enumOptionalPossible values:

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/model-notes/{model_note}

HTTPcURLJavaScriptPython

PUT /api/v1/model-notes/{model_note} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "note": "example_note",
  "private": "example_private",
  "patchworks_only": "example_patchworks_only",
  "colour": "blue"
}

{
  "data": {
    "id": 1,
    "note": "example_note",
    "private": "example_private",
    "patchworks_only": "example_patchworks_only",
    "model_type": "example_model_type",
    "model_id": 1,
    "colour": "blue",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "user_id": 1,
    "flow_step": {},
    "user": {}
  }
}

Destroy

delete

Delete a model note.

Authorizations

ApiKeyAuth

Path parameters

model_notestringRequired

The model note identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/model-notes/{model_note}

HTTPcURLJavaScriptPython

DELETE /api/v1/model-notes/{model_note} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "message": "Action completed successfully."
}