Foreign input sets

>>>

GET /api/templates/:template_id/foreign_input_sets
List foreign input sets

Examples

GET /api/templates/1007982320/foreign_input_sets
200
{
  "total": 1,
  "subtotal": 1,
  "page": 1,
  "per_page": 20,
  "search": null,
  "sort": {
    "by": null,
    "order": null
  },
  "results": [
    {
      "template_id": 1007982320,
      "target_template_name": "Job template 308",
      "include_all": true,
      "include": null,
      "exclude": null,
      "id": 17,
      "target_template_id": 1007982321
    }
  ]
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
search
optional

filter results

Validations:

  • String
order
optional

Sort and order by a searchable field, e.g. '<field> DESC'

Validations:

  • String
page
optional

Page number, starting at 1

Validations:

  • Must be a number.
per_page
optional

Number of results per page to return, 'all' to return all results

Validations:

  • Must match regular expression /\A([1-9]\d*|all)\Z$/.
>>>

GET /api/templates/:template_id/foreign_input_sets/:id
Show foreign input set details

Examples

GET /api/templates/1007982317-Job%20template%20304/foreign_input_sets/16
200
{
  "template_id": 1007982317,
  "target_template_name": "Job template 305",
  "include_all": true,
  "include": null,
  "exclude": null,
  "id": 16,
  "target_template_id": 1007982318
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

POST /api/templates/:template_id/foreign_input_sets
Create a foreign input set

Examples

POST /api/templates/1007982311-Job%20template%20298/foreign_input_sets
{
  "foreign_input_set": {}
}
422
{
  "error": {
    "id": null,
    "errors": {
      "target_template": [
        "can't be blank"
      ]
    },
    "full_messages": [
      "Target template can't be blank"
    ]
  }
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
foreign_input_set
required

Validations:

  • Hash
foreign_input_set[target_template_id]
required

Target template ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
foreign_input_set[include_all]
optional , nil allowed

Include all inputs from the foreign template

Validations:

  • Must be one of: true, false, 1, 0.
foreign_input_set[include]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • String
foreign_input_set[exclude]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • String
foreign_input_set[description]
optional , nil allowed

Input set description

Validations:

  • String
>>>

DELETE /api/templates/:template_id/foreign_input_sets/:id
Delete a foreign input set

Examples

DELETE /api/templates/1007982326-Job%20template%20313/foreign_input_sets/19
{
  "foreign_input_set": {}
}
200
{
  "id": 19,
  "template_id": 1007982326,
  "target_template_id": 1007982327,
  "include_all": true,
  "include": null,
  "exclude": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
>>>

PUT /api/templates/:template_id/foreign_input_sets/:id
Update a foreign input set

Examples

PUT /api/templates/1007982314-Job%20template%20301/foreign_input_sets/15
{
  "foreign_input_set": {
    "include_all": false
  }
}
200
{
  "include_all": false,
  "id": 15,
  "template_id": 1007982314,
  "target_template_id": 1007982315,
  "include": null,
  "exclude": null
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Integer
template_id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
id
required

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
foreign_input_set
required

Validations:

  • Hash
foreign_input_set[target_template_id]
optional

Target template ID

Validations:

  • string from 2 to 128 characters containing only alphanumeric characters, space, '_', '-' with no leading or trailing space..
foreign_input_set[include_all]
optional , nil allowed

Include all inputs from the foreign template

Validations:

  • Must be one of: true, false, 1, 0.
foreign_input_set[include]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • String
foreign_input_set[exclude]
optional , nil allowed

A comma separated list of input names to be included from the foreign template.

Validations:

  • String
foreign_input_set[description]
optional , nil allowed

Input set description

Validations:

  • String