Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional information
id

Primary Key

globally unique identifier

Required

jobs_id

Foreign key of the jobs

globally unique identifier

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs_reference_back_office

Embedded entity "jobs" using ERP PK when adding/updating

string

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

jobs

Embedded entity "jobs" when adding/updating

jobs

Optionally required : jobs_id, jobs_reference_back_office or jobs must be provided

work_instruction_details_id

work instruction details id

globally unique identifier
work_instruction_details_reference_back_office

Embedded code "work instruction details" when adding/updating

string
work_instruction_details

Embedded entity "work instruction details" when adding/updating

work_instruction_details
user_id

Filled by the person that completed that item on the checklist

globally unique identifier
work_instruction_action_type

Value from work_instruction_action_type.name

string
work_instruction_id

work instruction id

globally unique identifier

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction_reference_back_office

Embedded code "work instruction" when adding/updating

string

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

work_instruction

Embedded entity "work instruction" when adding/updating

work_instruction

Optionally required : work_instruction_id,work_instruction_reference_back_office or work_instruction must be provided

name

The "on what"

string

Required

Max length: 4000

status

Status can be Ok,NotOk,Replaced,NotApplicable

string

Max length: 50

date_done

Datetime filled when status goes to one valable status.

date
remark

Additional remark from the technician.

string

Max length: 255

advise

Additional advice from the technician.

string

Max length: 255

sequence

To order it.

integer
reference_back_office

The Id/Ref of the back office for this job work instruction. Used by Embedded entity

string

Max length: 255

group_name

Name of the group

string

Max length: 4000

group_sequence

Order of the group

integer
type

One of the possible types which are Regular, Form, Picture, UsedParts, BillableHours. Regular is the default

string
instruction_document_count

Specify how many documents/photos must be added if type is Picture

integer
db_report_type_id

When type is Form, you must specify which db_report_type must be filled

globally unique identifier
db_report_type_name

When type is Form, you must specify which db_report_type must be filled

string
modified_dateutc

Readonly system field managed by database, filled with GetUtcDate when adding,updating

date

Request Formats :

application/json, text/json

Sample:
{
  "id": "ce2604d9-9067-41af-8b5c-d6426825d13f",
  "jobs_id": "9a998de6-9557-431b-8597-98727ffdcead",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "0b53095c-01a8-46f5-a6cf-d8bab6e898b9",
    "_parent_id": "574b1c08-aa0b-439d-b859-81101150d2b7",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "1678a526-bf45-473d-9ed5-66f2ffc75d5f",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "68f4ab40-2032-4aa7-8c60-55a6d0cb2630",
      "_parent_id": "db031022-8019-45fa-baea-dab30d040c3f",
      "root_parent_id": "eeb65054-49e0-4e2b-b7b4-883b3affbf06",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "ffc31fed-44c8-4005-b1ec-33df0eb5efff",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "ef0e1407-6ba2-444e-8a62-83468c84a30c",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "1de685fa-4ef6-47bb-a120-a131114b68d5",
        "_parent_code": "sample string 6",
        "sales_organization_id": "9a3f1118-9bb4-4c64-bcdf-ddfe16322035",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
          "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
          "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
        },
        "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
      },
      "equipment_model_id": "bfa111fe-6b60-4d0e-bcca-009264504706",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "b57da0af-8e65-481f-ad74-ee965a434da6",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "35793436-469b-4fac-91b5-551bd1fde442",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "ceeec0f6-4c06-4e7b-9e17-fc5ac2eb65ff",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "e73a0c6d-ff7d-473e-8777-e3f63430df33",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
            "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
            "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
          },
          "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
        },
        "equipment_family_id": "2103e87f-474a-4b2a-8ea7-d1b11cfee262",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "ef0e1407-6ba2-444e-8a62-83468c84a30c",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "1de685fa-4ef6-47bb-a120-a131114b68d5",
          "_parent_code": "sample string 6",
          "sales_organization_id": "9a3f1118-9bb4-4c64-bcdf-ddfe16322035",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
            "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
            "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
            "accountancy_code": "sample string 8",
            "archived": true,
            "default_unit_of_measure_system_type": "sample string 10",
            "street": "sample string 11",
            "street2": "sample string 12",
            "street_number": "sample string 13",
            "zip": "sample string 14",
            "city": "sample string 15",
            "email": "sample string 16",
            "phone": "sample string 17",
            "fax": "sample string 18",
            "url": "sample string 19",
            "vat_reg_code": "sample string 20",
            "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
          },
          "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
        },
        "date_in_production_since": "2026-11-20T16:13:32.8717708+00:00",
        "date_out_of_production_since": "2026-11-20T16:13:32.8717708+00:00",
        "date_end_support": "2026-11-20T16:13:32.8717708+00:00",
        "sales_organization_id": "6a71a309-6c10-47da-b58a-3cf141b6d833",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
          "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
          "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
        },
        "replacement_period_nb_months": 14,
        "warranty_period_nb_months": 15,
        "translations": [
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          },
          {
            "field_name": "sample string 1",
            "language_code": "sample string 2",
            "value_translated": "sample string 3"
          }
        ],
        "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00"
      },
      "project_status_id": "119e1b8d-ba6f-4ddf-8ca6-d89952a1cd0b",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "27d95128-6281-4f9c-aa84-e18ac2d40c44",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "e6f54e03-cbd0-46f1-be10-8eff5a88f657",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
          "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
          "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
          "accountancy_code": "sample string 8",
          "archived": true,
          "default_unit_of_measure_system_type": "sample string 10",
          "street": "sample string 11",
          "street2": "sample string 12",
          "street_number": "sample string 13",
          "zip": "sample string 14",
          "city": "sample string 15",
          "email": "sample string 16",
          "phone": "sample string 17",
          "fax": "sample string 18",
          "url": "sample string 19",
          "vat_reg_code": "sample string 20",
          "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00"
      },
      "company_id": "ad1a16e0-1eb2-435d-a0b7-055417e6dd74",
      "company_code": "sample string 12",
      "db_address_id": "60278a48-0e29-4f00-acde-4bbb9e7a1a73",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "f15f5b3d-05ee-40be-9d74-9b909b365230",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "d974a711-bec1-45c7-b251-756dbdf8a5b1",
      "name": "sample string 19",
      "description": "sample string 20",
      "reference_back_office": "sample string 21",
      "serial_number": "sample string 22",
      "barcode": "sample string 23",
      "date_start_production": "2026-11-20T16:13:32.8893944+00:00",
      "date_create": "2026-11-20T16:13:32.8893944+00:00",
      "date_update": "2026-11-20T16:13:32.8893944+00:00",
      "updated_by_user_id": "b998392e-4490-41f4-8219-c3785713498e",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-20T16:13:32.8893944+00:00",
      "last_standard_result_score_1": "sample string 30",
      "last_standard_result_score_2": "sample string 31",
      "target_standard_result_score_1": "sample string 32",
      "target_standard_result_score_2": "sample string 33",
      "date_built": "2026-11-20T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-20T16:13:32.8893944+00:00",
      "date_last_job": "2026-11-20T16:13:32.8893944+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-20T16:13:32.8893944+00:00",
      "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "8cac739b-22e0-4d54-82c6-4a1cd864728d",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "0358ced0-2588-4ebf-a639-aad26adaa33a",
      "name": "sample string 2",
      "sales_organization_id": "7b3a75fb-1d82-4c15-987e-5b94e5c15c11",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "fd610aa1-3de5-47df-be34-2e2415f5c8f8",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "90fa9c00-73ed-479e-9297-e3289c1b32c1",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "8780e74a-962e-48cd-9d2f-59a083781b51",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
        "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
        "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00"
    },
    "job_status_id": "1938df42-3245-4dc2-8f0b-04f736685f32",
    "job_status_code": "sample string 11",
    "db_address_id": "4201084c-8660-4af3-8af3-301d3d48d50e",
    "contact_id": "50c0ef4b-7ea2-45ba-bfdc-b5ea565f7cf2",
    "requested_by_company_id": "e44ffb3a-eace-41f9-b7d8-472b89fe161a",
    "requested_by_contact_id": "cc0ba38b-c442-4e94-8c35-16060d6a0b15",
    "reference_back_office": "sample string 16",
    "name": "sample string 17",
    "description": "sample string 18",
    "working_sequence": 19,
    "internal_memo": "sample string 20",
    "prejob_information": "sample string 21",
    "estimated_time": 22,
    "earliest_date_plannable": "2026-11-20T16:13:32.8893944+00:00",
    "due_date": "2026-11-20T16:13:32.8893944+00:00",
    "date_create": "2026-11-20T16:13:32.8893944+00:00",
    "date_update": "2026-11-20T16:13:32.8893944+00:00",
    "date_closed": "2026-11-20T16:13:32.8893944+00:00",
    "suggested_user_id": "6e4e0bdb-8fd0-4464-a61a-a5fb148ee7fd",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "847aeb2c-620f-4bd5-8c41-d3ae06db7f0c",
      "db_language_id": "43866cde-34b2-4676-9a59-df7486bbf317",
      "username": "sample string 3",
      "firstname": "sample string 4",
      "lastname": "sample string 5",
      "code": "sample string 6",
      "archived": true,
      "disabled": true,
      "emergency_contact": "sample string 9",
      "bankaccount": "sample string 10",
      "social_security": "sample string 11",
      "place_of_birth": "sample string 12",
      "nationality": "sample string 13",
      "functions": "sample string 14",
      "birthdate": "2026-11-20T16:13:32.8893944+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "6b50564b-f9c3-4aac-933d-fecc5febca30",
      "sales_organization": {
        "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
        "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
        "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "fd31dce8-6838-4ca8-a1fd-7bc4470a5cb6",
      "email": "sample string 22",
      "phone": "sample string 23",
      "fax": "sample string 24",
      "mobile": "sample string 25",
      "private_email": "sample string 26",
      "private_phone": "sample string 27",
      "private_fax": "sample string 28",
      "private_mobile": "sample string 29",
      "private_street": "sample string 30",
      "private_street_number": "sample string 31",
      "private_city": "sample string 32",
      "private_zip": "sample string 33",
      "private_db_country_id": "2b34b043-6885-4a71-b956-57ee594db3e9",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "1c7f01b2-73d1-4f97-a6ab-210c7d724754"
    },
    "suggested_date_start": "2026-11-20T16:13:32.8893944+00:00",
    "skill_id": "6ec99aa7-cdbe-499d-8b81-bdefbcc6c62a",
    "skill_code": "sample string 32",
    "skill": {
      "id": "cf2d5737-eee2-430d-a51c-25d28ee4bd0c",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "752028c0-feff-4fce-8992-dad046d07c75",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c14f5664-02e3-4daa-9a47-63064319f3bd",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "189513e1-1acb-418d-9eaf-2dabc00f0c35",
        "db_currency_id": "b77c2e85-a0ce-446f-850f-e370cb645d51",
        "db_language_id": "4f6bc21b-8499-427b-a8a2-6d042395fbfb",
        "accountancy_code": "sample string 8",
        "archived": true,
        "default_unit_of_measure_system_type": "sample string 10",
        "street": "sample string 11",
        "street2": "sample string 12",
        "street_number": "sample string 13",
        "zip": "sample string 14",
        "city": "sample string 15",
        "email": "sample string 16",
        "phone": "sample string 17",
        "fax": "sample string 18",
        "url": "sample string 19",
        "vat_reg_code": "sample string 20",
        "modified_dateutc": "2026-11-20T16:13:32.8717708+00:00"
      },
      "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "2f2c59e2-4e3b-4752-8ecc-d9191193c6f9",
    "date_reported_by_company": "2026-11-20T16:13:32.8893944+00:00",
    "id2": 36,
    "company_id": "393c4240-ea05-45d2-8351-1fa07aa1ada5",
    "company_code": "sample string 38",
    "db_address_name": "sample string 39",
    "db_address_street": "sample string 40",
    "db_address_street2": "sample string 41",
    "db_address_street_number": "sample string 42",
    "db_address_city": "sample string 43",
    "db_address_zip": "sample string 44",
    "db_address_db_country_id": "02a3f66b-77d1-455d-b08c-32348d132057",
    "db_address_db_country_code": "sample string 46",
    "db_address_phone": "sample string 47",
    "db_address_email": "sample string 48",
    "db_address_latitude_decimal": 49.0,
    "db_address_longitude_decimal": 50.0,
    "estimated_quantity_remark": "sample string 51",
    "modified_dateutc": "2026-11-20T16:13:32.8893944+00:00"
  },
  "work_instruction_details_id": "2e673817-0d34-44ca-b05e-cfd811a8f5af",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "cc4719e0-c4ae-48fb-a117-6922d72bbdea",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "5999596c-f12c-49dc-9880-27ee73d4f498",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-20T16:13:32.8893944+00:00",
  "remark": "sample string 13",
  "advise": "sample string 14",
  "sequence": 1,
  "reference_back_office": "sample string 15",
  "group_name": "sample string 16",
  "group_sequence": 1,
  "type": "sample string 17",
  "instruction_document_count": 1,
  "db_report_type_id": "42f35003-2045-4e6a-ba5e-ca66f188ce05",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-20T16:13:32.9030184+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.