Virtual Environment Versions

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.

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• flow

• flow_count

• flowExists

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

virtual_environment_versionstringRequired

The virtual environment version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "flow_id": 1,
      "priority": 1,
      "model_type": "example_model_type",
      "original_model_id": 1,
      "replacement_model_id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "fallback": "example_fallback",
      "date_format": "example_date_format",
      "secret": "example_secret",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "version": 1,
      "virtual_environment_id": 1,
      "virtual_environment": {},
      "status": "Draft",
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployed_by": [],
      "notes": [],
      "manifests": [],
      "variables": [],
      "counts": "example_counts",
      "user_id": 1,
      "user": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities?page=1",
    "last": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities?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
flow_id		☑
priority	integer	☑

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

flow_idstringRequired

priorityintegerRequired

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "flow_id": 1,
  "priority": 1,
  "notes": "example_notes"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "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
flow_id
priority	integer

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

flow_prioritystringRequired

The flow priority identifier.

Body

application/json

flow_idstringOptional

priorityintegerOptional

notesstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 50

{
  "flow_id": 1,
  "priority": 1,
  "notes": "example_notes"
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Destroy

delete

Delete a flow prioritie.

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

flow_prioritystringRequired

The flow priority identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/flow-priorities/{flow_priority} 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.

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• originalModel

• originalModel_count

• originalModelExists

• replacementModel

• replacementModel_count

• replacementModelExists

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.

• model_type

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

virtual_environment_versionstringRequired

The virtual environment version identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "flow_id": 1,
      "priority": 1,
      "model_type": "example_model_type",
      "original_model_id": 1,
      "replacement_model_id": 1,
      "type": "example_type",
      "key": "example_key",
      "value": "example_value",
      "fallback": "example_fallback",
      "date_format": "example_date_format",
      "secret": "example_secret",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "version": 1,
      "virtual_environment_id": 1,
      "virtual_environment": {},
      "status": "Draft",
      "deployed_at": "2025-01-15T10:30:00.000000Z",
      "deployed_by": [],
      "notes": [],
      "manifests": [],
      "variables": [],
      "counts": "example_counts",
      "user_id": 1,
      "user": {}
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests?page=1",
    "last": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests?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
model_type	string	☑
original_model_id		☑
replacement_model_id		☑

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

model_typestringRequired

original_model_idstringRequired

replacement_model_idstringRequired

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "model_type": "example_model_type",
  "original_model_id": 1,
  "replacement_model_id": 1
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "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.

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

• originalModel

• originalModel_count

• originalModelExists

• replacementModel

• replacementModel_count

• replacementModelExists

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.

• model_type

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

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

get

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "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
model_type	string
original_model_id
replacement_model_id

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Body

application/json

model_typestringOptional

original_model_idstringOptional

replacement_model_idstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 82

{
  "model_type": "example_model_type",
  "original_model_id": 1,
  "replacement_model_id": 1
}

{
  "data": {
    "id": 1,
    "flow_id": 1,
    "priority": 1,
    "model_type": "example_model_type",
    "original_model_id": 1,
    "replacement_model_id": 1,
    "type": "example_type",
    "key": "example_key",
    "value": "example_value",
    "fallback": "example_fallback",
    "date_format": "example_date_format",
    "secret": "example_secret",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "version": 1,
    "virtual_environment_id": 1,
    "virtual_environment": {},
    "status": "Draft",
    "deployed_at": "2025-01-15T10:30:00.000000Z",
    "deployed_by": [],
    "notes": [],
    "manifests": [],
    "variables": [],
    "counts": "example_counts",
    "user_id": 1,
    "user": {}
  }
}

Destroy

delete

Delete a manifest.

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

manifeststringRequired

The manifest identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/manifests/{manifest} 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.

• virtualEnvironmentVersion

• virtualEnvironmentVersion_count

• virtualEnvironmentVersionExists

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

virtual_environment_versionstringRequired

The virtual environment version identifier.

Query parameters

filter[label]stringOptional

Filter results by label.

filter[key]stringOptional

Filter results by key.

filter[value]stringOptional

Filter results by value.

sortstringOptional

Sort field. Prefix with - for descending. Available: label, key, 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/virtual-environment-versions/{virtual_environment_version}/variables

HTTPcURLJavaScriptPython

GET /api/v1/virtual-environment-versions/{virtual_environment_version}/variables HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "label": "My Label",
      "key": "example_key",
      "value": "example_value",
      "secret": "example_secret",
      "locked": "example_locked",
      "configurable": "example_configurable",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z",
      "modified": "example_modified",
      "pivot": "example_pivot",
      "required": true,
      "advanced": true,
      "alias": "example_alias"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/variables",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/variables?page=1",
    "last": "https://api.example.com/api/v1/virtual-environment-versions/{virtual_environment_version}/variables?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
type	string	☑
key	string	☑
value
fallback	string
date_format	string
secret

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

Body

application/json

typestringRequired

keystring · min: 1Required

valuestring · max: 1024Optional

fallbackstring · max: 1024 · nullableOptional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables

HTTPcURLJavaScriptPython

POST /api/v1/virtual-environment-versions/{virtual_environment_version}/variables HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "type": "example_type",
  "key": "example_key",
  "value": "example_value",
  "fallback": "example_fallback",
  "date_format": "example_date_format",
  "secret": "example_secret"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

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
type	string
key	string
value
fallback	string
date_format	string
secret

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

variablestringRequired

The variable identifier.

Body

application/json

typestringOptional

keystring · min: 1Optional

valuestring · max: 1024Optional

fallbackstring · max: 1024 · nullableOptional

date_formatstring · nullableOptional

secretstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}

HTTPcURLJavaScriptPython

PUT /api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 159

{
  "type": "example_type",
  "key": "example_key",
  "value": "example_value",
  "fallback": "example_fallback",
  "date_format": "example_date_format",
  "secret": "example_secret"
}

{
  "data": {
    "id": 1,
    "label": "My Label",
    "key": "example_key",
    "value": "example_value",
    "secret": "example_secret",
    "locked": "example_locked",
    "configurable": "example_configurable",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z",
    "modified": "example_modified",
    "pivot": "example_pivot",
    "required": true,
    "advanced": true,
    "alias": "example_alias"
  }
}

Destroy

delete

Delete a variable.

Authorizations

ApiKeyAuth

Path parameters

virtual_environment_versionstringRequired

The virtual environment version identifier.

variablestringRequired

The variable identifier.

Responses

200

Successful response

application/json

messagestringOptional

401

Unauthenticated

403

Unauthorized

delete

/api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable}

HTTPcURLJavaScriptPython

DELETE /api/v1/virtual-environment-versions/{virtual_environment_version}/variables/{variable} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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