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": "b6507bdd-8246-4581-b703-cd5892fe6365",
  "jobs_id": "2c5d16f7-6e68-41c7-b49c-f97bd5117b39",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "574a6fa3-f83d-4f60-a2a3-3f8b65b8e9e4",
    "_parent_id": "b8ed6afe-4d5e-4cd7-8940-b1063e2d2f95",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "9fe43ba6-096b-4d3f-bd16-700bbea41127",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "f1478209-755e-4e88-952c-5618ec902bf4",
      "_parent_id": "8f0db1ce-9dd3-4eea-899e-d80013a24ba4",
      "root_parent_id": "3006f8f6-1998-485f-9fce-d5581e1b6ee0",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "2b5b1fa5-e24a-451b-9c0e-4593fe6ec360",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "7463caf0-1f0b-4e03-8e40-ce06dd961f6f",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "9fdfd6d1-dc10-4a78-9c04-e139c65555cc",
        "_parent_code": "sample string 6",
        "sales_organization_id": "5d0c5a6f-a130-4377-ac68-8e2c681e013a",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
          "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
          "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
          "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": "2025-07-17T10:19:12.2533893+00:00"
        },
        "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
      },
      "equipment_model_id": "cf628d8d-d43a-4348-b2ee-6e5efcfb575e",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "cd6a3c38-3f90-4d97-9428-a2229679e343",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "c4c086f1-df6c-4517-9fcd-c0bca54d92bd",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "2557286c-a7b7-415e-b033-1b12638342da",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "7317841e-fd95-4665-be1c-49b1fb042248",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
            "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
            "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
            "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": "2025-07-17T10:19:12.2533893+00:00"
          },
          "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
        },
        "equipment_family_id": "c701dad5-78fa-456b-a461-621daabc0dcd",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "7463caf0-1f0b-4e03-8e40-ce06dd961f6f",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "9fdfd6d1-dc10-4a78-9c04-e139c65555cc",
          "_parent_code": "sample string 6",
          "sales_organization_id": "5d0c5a6f-a130-4377-ac68-8e2c681e013a",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
            "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
            "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
            "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": "2025-07-17T10:19:12.2533893+00:00"
          },
          "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
        },
        "date_in_production_since": "2025-07-17T10:19:12.2533893+00:00",
        "date_out_of_production_since": "2025-07-17T10:19:12.2533893+00:00",
        "date_end_support": "2025-07-17T10:19:12.2533893+00:00",
        "sales_organization_id": "ad94cf62-06ea-41df-bb4c-14617ba5fb13",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
          "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
          "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
          "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": "2025-07-17T10:19:12.2533893+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": "2025-07-17T10:19:12.2533893+00:00"
      },
      "project_status_id": "9dced94f-b65a-4788-9eed-b4ea3011bc56",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "5920a3f0-cde7-4597-b703-d6607ad033d6",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "eccbb7c7-1a99-4327-8cf6-2f45b89a83bc",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
          "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
          "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
          "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": "2025-07-17T10:19:12.2533893+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
      },
      "company_id": "ff56c4ab-1c1c-4eb7-b7d6-a673c2581ca8",
      "company_code": "sample string 12",
      "db_address_id": "2caac202-728c-4ddd-8cc9-55e9aa6b6126",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "bbda66e9-03cf-4083-9a6d-b85baa5e0dcc",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "25718611-2922-48f7-807b-7f8e33147da5",
      "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": "2025-07-17T10:19:12.2533893+00:00",
      "date_create": "2025-07-17T10:19:12.2533893+00:00",
      "date_update": "2025-07-17T10:19:12.2533893+00:00",
      "updated_by_user_id": "a46a066e-9f6a-45f7-9638-f290f6f29fb4",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2025-07-17T10:19:12.2533893+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": "2025-07-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2025-07-17T10:19:12.2533893+00:00",
      "date_last_job": "2025-07-17T10:19:12.2533893+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2025-07-17T10:19:12.2533893+00:00",
      "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "13be4379-15ba-4970-a058-017779d1ec6a",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "98ddec65-3a1c-4f9e-926a-ea0b49256447",
      "name": "sample string 2",
      "sales_organization_id": "9e5ec07a-7b36-4f90-a73f-5896ceb0fe03",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "8cde1f4a-8e19-4ac5-a3e5-1cf87a5a9cf7",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "35bcac77-1cf4-4449-a02c-f4886c95d3f4",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "2f3bef21-0e17-4a1a-a951-099629fab0e0",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
        "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
        "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
        "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": "2025-07-17T10:19:12.2533893+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
    },
    "job_status_id": "e23aaad8-e3f9-4203-8543-d3b1cd57bd13",
    "job_status_code": "sample string 11",
    "db_address_id": "22cf2611-54a7-446d-9e41-6728b382a52c",
    "contact_id": "e242eb0a-e6a2-44f2-8d2d-7908a85833e6",
    "requested_by_company_id": "963174cd-c42f-40fe-a83d-ee06c5b675a0",
    "requested_by_contact_id": "44a1cddd-e954-46f4-84ae-bc1e69d4140e",
    "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": "2025-07-17T10:19:12.2533893+00:00",
    "due_date": "2025-07-17T10:19:12.2533893+00:00",
    "date_create": "2025-07-17T10:19:12.2533893+00:00",
    "date_update": "2025-07-17T10:19:12.2533893+00:00",
    "date_closed": "2025-07-17T10:19:12.2533893+00:00",
    "suggested_user_id": "5d176e33-f479-4c77-b909-242f057f031f",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "31b4e6bf-9f2e-4660-8f2d-688c8b22bdd8",
      "db_language_id": "adafabee-c72f-405e-aa4f-cc64d1aafe9a",
      "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": "2025-07-17T10:19:12.2533893+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "cb28c2ab-5644-4048-af40-84a2bfe4e330",
      "sales_organization": {
        "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
        "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
        "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
        "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": "2025-07-17T10:19:12.2533893+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "43957976-79f9-45fb-8bd5-a08038fe27a5",
      "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": "f5c6b033-3571-4b1e-ab92-e002fb953947",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "0763ee33-0b2b-4e39-b176-a6194bad3ea9"
    },
    "suggested_date_start": "2025-07-17T10:19:12.2533893+00:00",
    "skill_id": "638125c9-7064-40f9-9e7b-2020e94aaf73",
    "skill_code": "sample string 32",
    "skill": {
      "id": "636a94e4-0819-43dd-a589-c841e5b1d625",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "a1c76967-a1cf-4719-8ce5-3f74641e2f60",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "63133d62-25ea-4218-ba41-9326c9c3d511",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "5cb4fe51-2b1e-459d-a6d6-d5361be6605b",
        "db_currency_id": "62ad0716-3295-4427-aaf3-4d2841d5f97e",
        "db_language_id": "5f12fc8b-90a3-4782-999d-a77b7e1cb567",
        "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": "2025-07-17T10:19:12.2533893+00:00"
      },
      "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "638ab096-d0c4-40bb-be41-10aca4ac379a",
    "date_reported_by_company": "2025-07-17T10:19:12.2533893+00:00",
    "id2": 36,
    "company_id": "f044a6a8-0918-4fcc-8c69-00f3ca1f2810",
    "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": "54317de0-73b3-4239-aa9b-1d7b39a5e83e",
    "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": "2025-07-17T10:19:12.2533893+00:00"
  },
  "work_instruction_details_id": "a7e6fb4b-fcf6-4f13-838f-7ba60b459275",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "977fd046-174f-48e7-bf83-446da23daed6",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "9cd2c732-3e16-49e1-9a7a-871d2e000563",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2025-07-17T10:19:12.2533893+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": "b954f91c-6cd1-4b95-9837-091f04deb6cc",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2025-07-17T10:19:12.2533893+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.