Marketplace Apps | API Reference (WIP)

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

☑

help_guide

flow_version_ids

flow_version_ids.*

cross_reference_lookup_ids

cross_reference_lookup_ids.*

system_ids

system_ids.*

script_version_ids

script_version_ids.*

cache_ids

cache_ids.*

data_pool_ids

data_pool_ids.*

private

Authorizations

Body

help_guidestring · uri · nullableOptional

flow_version_idsstringOptional

cross_reference_lookup_idsstringOptional

system_idsstringOptional

script_version_idsstringOptional

cache_idsstringOptional

data_pool_idsstringOptional

privatestringOptional

namestring · max: 100Required

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/marketplace-apps

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

{
  "help_guide": "https://example.com",
  "flow_version_ids": "example_flow_version_ids",
  "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
  "system_ids": "example_system_ids",
  "script_version_ids": "example_script_version_ids",
  "cache_ids": "example_cache_ids",
  "data_pool_ids": "example_data_pool_ids",
  "private": "example_private",
  "name": "My Example",
  "labels": []
}

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Install

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_template_ids

flow_template_ids.*

integer

instances

instances.*.system_template_id

integer

☑

instances.*.connector_id

integer

instances.*.authentication_implementation_template_id

integer

instances.*

Authorizations

Path parameters

marketplaceAppstringRequired

The marketplaceApp identifier.

Body

flow_template_idsstringOptional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/marketplace-apps/{marketplaceApp}/install

POST /api/v1/marketplace-apps/{marketplaceApp}/install HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 49

{
  "flow_template_ids": "example_flow_template_ids"
}

{}

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

flow_version_ids

flow_version_ids.*

cross_reference_lookup_ids

cross_reference_lookup_ids.*

system_ids

system_ids.*

script_version_ids

script_version_ids.*

cache_ids

cache_ids.*

data_pool_ids

data_pool_ids.*

Authorizations

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Body

flow_version_idsstringOptional

cross_reference_lookup_idsstringOptional

system_idsstringOptional

script_version_idsstringOptional

cache_idsstringOptional

data_pool_idsstringOptional

namestring · max: 100Optional

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

put

/api/v1/marketplace-apps/{marketplace_app}

PUT /api/v1/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Content-Type: application/json
Accept: */*
Content-Length: 289

{
  "flow_version_ids": "example_flow_version_ids",
  "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
  "system_ids": "example_system_ids",
  "script_version_ids": "example_script_version_ids",
  "cache_ids": "example_cache_ids",
  "data_pool_ids": "example_data_pool_ids",
  "name": "My Example"
}

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

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.

flowTemplates
flowTemplates_count
flowTemplatesExists
crossReferenceLookupTemplates
crossReferenceLookupTemplates_count
crossReferenceLookupTemplatesExists
crossReferenceLookupTemplates.crossReferenceLookupValueTemplates
systemTemplates
systemTemplates_count
systemTemplatesExists
systemTemplates.logo
scriptTemplates
scriptTemplates_count
scriptTemplatesExists
cacheTemplates
cacheTemplates_count
cacheTemplatesExists
dataPoolTemplates
dataPoolTemplates_count
dataPoolTemplatesExists
company
company_count
companyExists
marketplaceCompany
marketplaceCompany_count
marketplaceCompanyExists
publicCompany
publicCompany_count
publicCompanyExists

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.

id
name
allowed
private
private_or_allowed

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
id
created_at

Authorizations

Query parameters

filter[id]stringOptional

Filter results by id.

filter[name]stringOptional

Filter results by name.

filter[allowed]stringOptional

Filter results by allowed.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[private_or_allowed]stringOptional

Filter results by private_or_allowed.

filter[labelled]stringOptional

Filter results by labelled.

includestringOptional

Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs

sortstringOptional

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

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/patchworks/marketplace-apps

GET /api/v1/patchworks/marketplace-apps HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": [
    {
      "id": 1,
      "help_guide": "example_help_guide",
      "flow_version_ids": "example_flow_version_ids",
      "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
      "system_ids": "example_system_ids",
      "script_version_ids": "example_script_version_ids",
      "cache_ids": "example_cache_ids",
      "data_pool_ids": "example_data_pool_ids",
      "private": "example_private",
      "created_at": "2025-01-15T10:30:00.000000Z",
      "updated_at": "2025-01-15T10:30:00.000000Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "path": "https://api.example.com/api/v1/patchworks/marketplace-apps",
    "per_page": 25,
    "to": 1,
    "total": 1
  },
  "links": {
    "first": "https://api.example.com/api/v1/patchworks/marketplace-apps?page=1",
    "last": "https://api.example.com/api/v1/patchworks/marketplace-apps?page=1",
    "prev": null,
    "next": null
  }
}

Store

post

Create a new convert all.

Authorizations

Responses

200

Successful response

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/marketplace-apps/convert-all

POST /api/v1/patchworks/marketplace-apps/convert-all HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Store

post

Create a new convert by company.

Authorizations

Responses

200

Successful response

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/marketplace-apps/convert-by-company

POST /api/v1/patchworks/marketplace-apps/convert-by-company HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Get Convertible

get

Get Convertible for convertible.

Authorizations

Responses

200

Successful response

401

Unauthenticated

403

Unauthorized

get

/api/v1/patchworks/marketplace-apps/convertible

GET /api/v1/patchworks/marketplace-apps/convertible HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

Convert

post

Convert for convert.

Authorizations

Path parameters

marketplaceAppstringRequired

The marketplaceApp identifier.

Responses

200

Successful response

401

Unauthenticated

403

Unauthorized

422

Validation Error

application/json

post

/api/v1/patchworks/marketplace-apps/{marketplaceApp}/convert

POST /api/v1/patchworks/marketplace-apps/{marketplaceApp}/convert HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

No content

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.

flowTemplates
flowTemplates_count
flowTemplatesExists
crossReferenceLookupTemplates
crossReferenceLookupTemplates_count
crossReferenceLookupTemplatesExists
crossReferenceLookupTemplates.crossReferenceLookupValueTemplates
systemTemplates
systemTemplates_count
systemTemplatesExists
systemTemplates.logo
scriptTemplates
scriptTemplates_count
scriptTemplatesExists
cacheTemplates
cacheTemplates_count
cacheTemplatesExists
dataPoolTemplates
dataPoolTemplates_count
dataPoolTemplatesExists
company
company_count
companyExists
marketplaceCompany
marketplaceCompany_count
marketplaceCompanyExists
publicCompany
publicCompany_count
publicCompanyExists

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.

id
name
allowed
private
private_or_allowed

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
id
created_at

Authorizations

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Query parameters

filter[id]stringOptional

Filter results by id.

filter[name]stringOptional

Filter results by name.

filter[allowed]stringOptional

Filter results by allowed.

filter[private]stringOptional

Filter results by private.

filter[visibility]stringOptional

Filter results by visibility.

filter[private_or_allowed]stringOptional

Filter results by private_or_allowed.

filter[labelled]stringOptional

Filter results by labelled.

includestringOptional

Comma-separated list of relationships to include. Available: flowTemplates, crossReferenceLookupTemplates, crossReferenceLookupTemplates.crossReferenceLookupValueTemplates, systemTemplates, systemTemplates.logo, scriptTemplates, cacheTemplates, dataPoolTemplates, company, marketplaceCompany, publicCompany, installs

sortstringOptional

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

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/patchworks/marketplace-apps/{marketplace_app}

GET /api/v1/patchworks/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

{
  "data": {
    "id": 1,
    "help_guide": "example_help_guide",
    "flow_version_ids": "example_flow_version_ids",
    "cross_reference_lookup_ids": "example_cross_reference_lookup_ids",
    "system_ids": "example_system_ids",
    "script_version_ids": "example_script_version_ids",
    "cache_ids": "example_cache_ids",
    "data_pool_ids": "example_data_pool_ids",
    "private": "example_private",
    "created_at": "2025-01-15T10:30:00.000000Z",
    "updated_at": "2025-01-15T10:30:00.000000Z"
  }
}

Destroy

delete

Delete a marketplace app.

Authorizations

Path parameters

marketplace_appstringRequired

The marketplace app identifier.

Responses

200

Successful response

application/json

401

Unauthenticated

403

Unauthorized

delete

/api/v1/patchworks/marketplace-apps/{marketplace_app}

DELETE /api/v1/patchworks/marketplace-apps/{marketplace_app} HTTP/1.1
Host: core.wearepatchworks.com
Accept: */*

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

hashtagStore

hashtagValidation Rules

hashtagInstall

hashtagValidation Rules

hashtagUpdate

hashtagValidation Rules

hashtagIndex

hashtagPagination

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagStore

hashtagStore

hashtagGet Convertible

hashtagConvert

hashtagShow

hashtagAvailable Includes

hashtagAvailable Filters

hashtagAvailable Sorts

hashtagDestroy

Store

Validation Rules

Install

Validation Rules

Update

Validation Rules

Index

Pagination

Available Includes

Available Filters

Available Sorts

Store

Store

Get Convertible

Convert

Show

Available Includes

Available Filters

Available Sorts

Destroy