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": "458f2ec5-84a6-4728-9f4a-c7cb5b8af633",
  "jobs_id": "ee51621a-238e-4b83-84c3-e4d34bce3752",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "082671a7-c43c-45ed-9999-b13799d26225",
    "_parent_id": "85ee72fa-b0e8-49dd-a9ff-8da0d249b49e",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "cda623d4-cb9c-40a3-86af-38fb906af0dd",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "83f93a2e-3efc-49a1-ac54-7c2edb3e1d12",
      "_parent_id": "1e21911c-2e25-46ff-841e-189880e96a51",
      "root_parent_id": "68ecf361-6299-4f31-a67b-970b702e509a",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "312dea02-863a-4406-b828-bd1d38f714f4",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "912e3faf-ea26-45cb-831b-2bba812cb417",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "6d55002b-af7c-4e94-af0a-3301a0781ab8",
        "_parent_code": "sample string 6",
        "sales_organization_id": "c458745c-4d4b-4445-997f-593bda159e6b",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
          "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
          "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
          "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-20T10:30:37.5749129+00:00"
        },
        "modified_dateutc": "2026-11-20T10:30:37.5749129+00:00"
      },
      "equipment_model_id": "257afdd3-0028-4df2-baa6-3dcfb9f9df26",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "12be906e-c2ed-46b3-b3c9-ff2a157aa8e0",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "69a64c8e-6e82-4ecf-8f27-3a4fbcd2450d",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "55e67b55-6724-4f88-97c6-4939e87fba4e",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "d52d7ace-00cd-4834-8855-5c73fa83dd1e",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
            "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
            "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
            "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-20T10:30:37.5749129+00:00"
          },
          "modified_dateutc": "2026-11-20T10:30:37.5749129+00:00"
        },
        "equipment_family_id": "988f91ce-5117-4f88-92e6-298c411b416d",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "912e3faf-ea26-45cb-831b-2bba812cb417",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "6d55002b-af7c-4e94-af0a-3301a0781ab8",
          "_parent_code": "sample string 6",
          "sales_organization_id": "c458745c-4d4b-4445-997f-593bda159e6b",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
            "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
            "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
            "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-20T10:30:37.5749129+00:00"
          },
          "modified_dateutc": "2026-11-20T10:30:37.5749129+00:00"
        },
        "date_in_production_since": "2026-11-20T10:30:37.5749129+00:00",
        "date_out_of_production_since": "2026-11-20T10:30:37.5749129+00:00",
        "date_end_support": "2026-11-20T10:30:37.5749129+00:00",
        "sales_organization_id": "e4b0799f-6b9e-4cf3-b5b1-ed36a9cb1217",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
          "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
          "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
          "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-20T10:30:37.5749129+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-20T10:30:37.5850073+00:00"
      },
      "project_status_id": "7d77f560-795c-44f3-a111-63c2b3ba1b9e",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "36d5a615-124c-4f42-97f1-cbbef6096731",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "5ee9c052-65c2-4215-923a-a723484e8811",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
          "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
          "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
          "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-20T10:30:37.5749129+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00"
      },
      "company_id": "20349f9d-a897-4ca4-9c28-4532ce8f6a03",
      "company_code": "sample string 12",
      "db_address_id": "b0876833-2127-4872-8d02-718a89176974",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "583b486b-9db5-4bad-85df-47c7405b7678",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "7afb99de-12b0-41a2-8bfe-1f60ef4ebc1c",
      "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-20T10:30:37.5850073+00:00",
      "date_create": "2026-11-20T10:30:37.5850073+00:00",
      "date_update": "2026-11-20T10:30:37.5850073+00:00",
      "updated_by_user_id": "bf6fe621-3757-4b5c-aac6-157cee97b491",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-20T10:30:37.5850073+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-20T10:30:37.5850073+00:00",
      "date_last_job": "2026-11-20T10:30:37.5850073+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-20T10:30:37.5850073+00:00",
      "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "3a0e6772-cfcd-4bd6-a7f1-9899dfcdf1e5",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "7c3c3dee-f687-4433-883f-fac1ce9e31af",
      "name": "sample string 2",
      "sales_organization_id": "38ac5f5d-ce1f-448f-98b2-d1534cc7115e",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "47238f20-f95d-44be-b99e-53c922b35a51",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "07408d28-bf99-421a-adad-2bd0c778da40",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "b62f10da-0fa2-4a6c-b572-03ee6549158a",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
        "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
        "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
        "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-20T10:30:37.5749129+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00"
    },
    "job_status_id": "12681f58-5712-4df9-9713-33783a5b0ee2",
    "job_status_code": "sample string 11",
    "db_address_id": "7995d55f-7387-4793-a704-bee13ce8de04",
    "contact_id": "846669a3-4bc2-4b33-b1e1-1c40a5631745",
    "requested_by_company_id": "e34eb50c-14f7-44f1-b13f-f2964c819791",
    "requested_by_contact_id": "a34af638-6e06-474d-9b33-ff733795079f",
    "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-20T10:30:37.5850073+00:00",
    "due_date": "2026-11-20T10:30:37.5850073+00:00",
    "date_create": "2026-11-20T10:30:37.5850073+00:00",
    "date_update": "2026-11-20T10:30:37.5850073+00:00",
    "date_closed": "2026-11-20T10:30:37.5850073+00:00",
    "suggested_user_id": "d6ec37c8-ac2d-4170-9703-a108bad3d2af",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "a9f2e4d8-cdab-40b6-97ce-1c7809b0dfa5",
      "db_language_id": "3dc2e939-27a1-4136-8dfa-72da26bcc7a0",
      "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-20T10:30:37.5850073+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "9b56fefe-3643-4d50-9f78-c1d5b57d9598",
      "sales_organization": {
        "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
        "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
        "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
        "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-20T10:30:37.5749129+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "0c438e75-44cc-476f-acf7-30188b96d5d8",
      "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": "2740916d-2950-4e79-a5ce-29c04615f74b",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "3bef2b63-c04c-44f9-a6ee-79617ede1de9"
    },
    "suggested_date_start": "2026-11-20T10:30:37.5850073+00:00",
    "skill_id": "1e539bb5-a114-48ef-b6c2-0f73ce8135e2",
    "skill_code": "sample string 32",
    "skill": {
      "id": "f58916ba-e761-4d69-905d-b0263cdf311d",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "8d057d40-b177-4d82-ba1c-fe8d90e91e94",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c113ed10-9693-4120-a7c9-ac5b9c314852",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f7553a5a-0a8e-47be-a564-5729aa935629",
        "db_currency_id": "cfe9b56f-4229-470b-b17e-ffd62fbf0563",
        "db_language_id": "3d0c1c67-ed79-4eff-835c-f7d3d79025b9",
        "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-20T10:30:37.5749129+00:00"
      },
      "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "1d9b86dd-e5a2-4483-8a73-15a41e865f54",
    "date_reported_by_company": "2026-11-20T10:30:37.5850073+00:00",
    "id2": 36,
    "company_id": "1a851660-2458-4916-b19d-d7c5aa98db85",
    "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": "797a3d94-0254-4eb3-af1e-3f6bece63c1d",
    "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-20T10:30:37.5850073+00:00"
  },
  "work_instruction_details_id": "27afcfd7-9a08-4c42-81dc-8a2d2d6de238",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "6006799e-f8c7-4376-955a-7c5c81a26f17",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "5c2d3fc9-62f7-48d1-b46c-6749d2dbf6a5",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-20T10:30:37.5850073+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": "6c367184-e706-4169-bb30-9ebfc7c48e27",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-20T10:30:37.5850073+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.