Cross Reference Lookups | API Reference (WIP)

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.

crossReferenceLookupValues
crossReferenceLookupValues_count
crossReferenceLookupValuesExists

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.

name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

cross_reference_lookups.id
cross_reference_lookups.cross_reference_lookup_template_id
cross_reference_lookups.name
cross_reference_lookups.description
cross_reference_lookups.default_value
cross_reference_lookups.created_at
cross_reference_lookups.updated_at
cross_reference_lookups.deleted_at

Available Sorts

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

name

Authorizations

Query parameters

filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: crossReferenceLookupValues

sortstringOptional

Sort field. Prefix with - for descending. Available: name

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/cross-reference-lookups

GET /api/v1/cross-reference-lookups HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "cross_reference_lookup_template_id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "default_value": "example_default_value",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "deleted_at": "2025-01-15T10:30:00.000000Z",
      "left_value": "example_left_value",
      "right_value": "example_right_value",
      "cross_reference_lookup_values": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/cross-reference-lookups",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/cross-reference-lookups?page=1",
    "last": "https://api.example.com/api/v1/cross-reference-lookups?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

name

string

☑

description

string

☑

default_value

Authorizations

Body

descriptionstringRequired

default_valuestring · nullableOptional

namestringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups

POST /api/v1/cross-reference-lookups HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "description": "A description of the resource",
  "default_value": "example_default_value",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

Install

post

Install for install.

Authorizations

Path parameters

crossReferenceLookupTemplatestringRequired

The crossReferenceLookupTemplate identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups/{crossReferenceLookupTemplate}/install

POST /api/v1/cross-reference-lookups/{crossReferenceLookupTemplate}/install HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

Upload

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

private

Authorizations

Path parameters

crossReferenceLookupstringRequired

The crossReferenceLookup identifier.

Body

privatestringOptional

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups/{crossReferenceLookup}/upload

POST /api/v1/cross-reference-lookups/{crossReferenceLookup}/upload HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "private": "example_private"
}

{}

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.

crossReferenceLookupValues
crossReferenceLookupValues_count
crossReferenceLookupValuesExists

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.

name

Available Fields

These are the fields that can be requested to limit the data returned. Please see the section on using fields for more details.

cross_reference_lookups.id
cross_reference_lookups.cross_reference_lookup_template_id
cross_reference_lookups.name
cross_reference_lookups.description
cross_reference_lookups.default_value
cross_reference_lookups.created_at
cross_reference_lookups.updated_at
cross_reference_lookups.deleted_at

Available Sorts

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

name

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[id]stringOptional

Filter results by id.

filter[,]stringOptional

Filter results by ,.

includestringOptional

Comma-separated list of relationships to include. Available: crossReferenceLookupValues

sortstringOptional

Sort field. Prefix with - for descending. Available: name

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/cross-reference-lookups/{cross_reference_lookup}

GET /api/v1/cross-reference-lookups/{cross_reference_lookup} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

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

name

string

description

string

default_value

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Body

descriptionstringOptional

default_valuestring · nullableOptional

namestringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/cross-reference-lookups/{cross_reference_lookup}

PUT /api/v1/cross-reference-lookups/{cross_reference_lookup} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 107

{
  "description": "A description of the resource",
  "default_value": "example_default_value",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

Destroy

delete

Delete a cross reference lookup.

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/cross-reference-lookups/{cross_reference_lookup}

DELETE /api/v1/cross-reference-lookups/{cross_reference_lookup} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Clear

post

Clear for clear.

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Responses

200

Successful response

No content

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups/{cross_reference_lookup}/clear

POST /api/v1/cross-reference-lookups/{cross_reference_lookup}/clear HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Index

get

Pagination

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

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.

cross_reference_lookup_id
left_value
right_value

Available Sorts

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

cross_reference_lookup_id
left_value
right_value

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Query parameters

filter[cross_reference_lookup_id]stringOptional

Filter results by cross_reference_lookup_id.

filter[left_value]stringOptional

Filter results by left_value.

filter[right_value]stringOptional

Filter results by right_value.

sortstringOptional

Sort field. Prefix with - for descending. Available: cross_reference_lookup_id, left_value, right_value

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/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values

GET /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "cross_reference_lookup_template_id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "default_value": "example_default_value",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "deleted_at": "2025-01-15T10:30:00.000000Z",
      "left_value": "example_left_value",
      "right_value": "example_right_value",
      "cross_reference_lookup_values": []
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values?page=1",
    "last": "https://api.example.com/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values?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

left_value

right_value

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Body

left_valuestring · nullableOptional

right_valuestring · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values

POST /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "left_value": "example_left_value",
  "right_value": "example_right_value"
}

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

Import

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

values_file

☑

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Body

values_filestringRequired

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/import

POST /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/import HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "values_file": "example_values_file"
}

{}

Show

get

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.

cross_reference_lookup_id
left_value
right_value

Available Sorts

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

cross_reference_lookup_id
left_value
right_value

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

cross_reference_lookup_valuestringRequired

The cross reference lookup value identifier.

Query parameters

filter[cross_reference_lookup_id]stringOptional

Filter results by cross_reference_lookup_id.

filter[left_value]stringOptional

Filter results by left_value.

filter[right_value]stringOptional

Filter results by right_value.

sortstringOptional

Sort field. Prefix with - for descending. Available: cross_reference_lookup_id, left_value, right_value

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/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}

GET /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

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

left_value

right_value

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

cross_reference_lookup_valuestringRequired

The cross reference lookup value identifier.

Body

left_valuestring · nullableOptional

right_valuestring · nullableOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}

PUT /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "left_value": "example_left_value",
  "right_value": "example_right_value"
}

{
  "data": {
    "id": 1,
    "cross_reference_lookup_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "default_value": "example_default_value",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "deleted_at": "2025-01-15T10:30:00.000000Z",
    "left_value": "example_left_value",
    "right_value": "example_right_value",
    "cross_reference_lookup_values": []
  }
}

Destroy

delete

Delete a cross reference lookup value.

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

cross_reference_lookup_valuestringRequired

The cross reference lookup value identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value}

DELETE /api/v1/cross-reference-lookups/{cross_reference_lookup}/cross-reference-lookup-values/{cross_reference_lookup_value} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

Download

get

Download for download.

Authorizations

Path parameters

cross_reference_lookupstringRequired

The cross reference lookup identifier.

Responses

200

Successful response

application/json

objectOptional

401

Unauthenticated

403

Unauthorized

get

/api/v1/cross-reference-lookups/{cross_reference_lookup}/download

GET /api/v1/cross-reference-lookups/{cross_reference_lookup}/download HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{}

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagInstall

hashtagUpload

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagClear

hashtagIndex

hashtagPagination

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagImport

hashtagValidation Rules

hashtagShow

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagDownload

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Install

Upload

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Clear

Index

Pagination

Available Filters

Available Sorts

Store

Validation Rules

Import

Validation Rules

Show

Available Filters

Available Sorts

Update

Validation Rules

Destroy

Download