Scripts | API Reference (WIP) | Product documentation

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.

versions
versions_count
versionsExists
versions.content
latestVersion
latestVersion_count
latestVersionExists
latestVersion.content

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
versions.id

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.

scripts.id
scripts.script_template_id
scripts.name
scripts.description
scripts.language
scripts.created_at
scripts.updated_at
versions.id
versions.script_id
versions.version
versions.name
versions.deployed_at
versions.deployment_failed_at
versions.deploying
versions.deployment_failure_reason

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[versions.id]stringOptional

Filter results by versions.id.

includestringOptional

Comma-separated list of relationships to include. Available: versions, versions.content, latestVersion, latestVersion.content

sortstringOptional

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

fields[versions]stringOptional

Comma-separated list of versions fields to return. Available: id, script_id, version, name, deployed_at, deployment_failed_at, deploying, deployment_failure_reason

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/scripts

GET /api/v1/scripts HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "script_template_id": 1,
      "name": "My Example",
      "description": "A description of the resource",
      "language": "example_language",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "script_id": 1,
      "version": 1,
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
      "deploying": "example_deploying",
      "deployment_failure_reason": "example_deployment_failure_reason",
      "content": "example_content",
      "ai_created": "example_ai_created",
      "value": "example_value",
      "versions": [],
      "latest_version": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/scripts",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/scripts?page=1",
    "last": "https://api.example.com/api/v1/scripts?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

language

string

☑

ai_created

Authorizations

Body

descriptionstring · max: 255 · nullableOptional

languagestringRequired

ai_createdstring · nullableOptional

namestring · max: 255Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/scripts

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

{
  "description": "A description of the resource",
  "language": "example_language",
  "ai_created": "example_ai_created",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "script_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "language": "example_language",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "script_id": 1,
    "version": 1,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
    "deploying": "example_deploying",
    "deployment_failure_reason": "example_deployment_failure_reason",
    "content": "example_content",
    "ai_created": "example_ai_created",
    "value": "example_value",
    "versions": [],
    "latest_version": {}
  }
}

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.

versions
versions_count
versionsExists
versions.content
latestVersion
latestVersion_count
latestVersionExists
latestVersion.content

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
versions.id

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.

scripts.id
scripts.script_template_id
scripts.name
scripts.description
scripts.language
scripts.created_at
scripts.updated_at
versions.id
versions.script_id
versions.version
versions.name
versions.deployed_at
versions.deployment_failed_at
versions.deploying
versions.deployment_failure_reason

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

scriptstringRequired

The script identifier.

Query parameters

filter[name]stringOptional

Filter results by name.

filter[versions.id]stringOptional

Filter results by versions.id.

includestringOptional

Comma-separated list of relationships to include. Available: versions, versions.content, latestVersion, latestVersion.content

sortstringOptional

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

fields[versions]stringOptional

Comma-separated list of versions fields to return. Available: id, script_id, version, name, deployed_at, deployment_failed_at, deploying, deployment_failure_reason

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/scripts/{script}

GET /api/v1/scripts/{script} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "script_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "language": "example_language",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "script_id": 1,
    "version": 1,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
    "deploying": "example_deploying",
    "deployment_failure_reason": "example_deployment_failure_reason",
    "content": "example_content",
    "ai_created": "example_ai_created",
    "value": "example_value",
    "versions": [],
    "latest_version": {}
  }
}

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

language

string

value

string

Authorizations

Path parameters

scriptstringRequired

The script identifier.

Body

descriptionstring · max: 255 · nullableOptional

languagestringOptional

valuestring · min: 1Optional

namestring · max: 255Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/scripts/{script}

PUT /api/v1/scripts/{script} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 121

{
  "description": "A description of the resource",
  "language": "example_language",
  "value": "example_value",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "script_template_id": 1,
    "name": "My Example",
    "description": "A description of the resource",
    "language": "example_language",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "script_id": 1,
    "version": 1,
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
    "deploying": "example_deploying",
    "deployment_failure_reason": "example_deployment_failure_reason",
    "content": "example_content",
    "ai_created": "example_ai_created",
    "value": "example_value",
    "versions": [],
    "latest_version": {}
  }
}

Destroy

delete

Delete a script.

Authorizations

Path parameters

scriptstringRequired

The script identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/scripts/{script}

DELETE /api/v1/scripts/{script} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

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.

content
content_count
contentExists
script
script_count
scriptExists

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.

is_deployed

Authorizations

Path parameters

scriptstringRequired

The script identifier.

Query parameters

filter[is_deployed]stringOptional

Filter results by is_deployed.

filter[deployed_at]stringOptional

Filter results by deployed_at.

includestringOptional

Comma-separated list of relationships to include. Available: content, script

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/scripts/{script}/script-versions

GET /api/v1/scripts/{script}/script-versions HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "script_id": 1,
      "name": "My Example",
      "version": 1,
      "status": "Draft",
      "deployment_failure_reason": "example_deployment_failure_reason",
      "last_invoked_on": "example_last_invoked_on",
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
      "deploying": "example_deploying",
      "content": {},
      "script": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/scripts/{script}/script-versions",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/scripts/{script}/script-versions?page=1",
    "last": "https://api.example.com/api/v1/scripts/{script}/script-versions?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

content

string

☑

Authorizations

Path parameters

scriptstringRequired

The script identifier.

Body

contentstring · min: 1Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/scripts/{script}/script-versions

POST /api/v1/scripts/{script}/script-versions HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "content": "example_content"
}

{
  "data": {
    "id": 1,
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "script_id": 1,
    "name": "My Example",
    "version": 1,
    "status": "Draft",
    "deployment_failure_reason": "example_deployment_failure_reason",
    "last_invoked_on": "example_last_invoked_on",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployment_failed_at": "2025-01-15T10:30:00.000000Z",
    "deploying": "example_deploying",
    "content": {},
    "script": {}
  }
}

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagStore

hashtagValidation Rules

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Fields

hashtagAvailable Sorts

hashtagUpdate

hashtagValidation Rules

hashtagDestroy

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagStore

hashtagValidation Rules

Index

Pagination

Available Includes

Available Filters

Available Fields

Available Sorts

Store

Validation Rules

Show

Available Includes

Available Filters

Available Fields

Available Sorts

Update

Validation Rules

Destroy

Index

Pagination

Available Includes

Available Filters

Store

Validation Rules