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": "f074bbb1-ce2b-4919-8e96-13223eeb3067",
  "jobs_id": "ee4f9c6d-e920-4e70-90bd-0de79c935257",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "249a5819-e4d3-4d50-8880-4b94379f35c1",
    "_parent_id": "225610f7-cd50-4696-a6b0-bbc574c4b544",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "22a27904-d5ea-4336-b39a-808db3312aca",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "ca439d3d-a1e9-416f-a494-c7e80965cf75",
      "_parent_id": "da4d1d0a-be6e-4b8c-a56c-59eebb4bcf74",
      "root_parent_id": "a0476799-25d5-4262-9b0a-1342bf2cddc3",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "713039f5-c6d1-43ae-95a6-8dfce567e568",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "824d1c8c-f4c9-4f58-a286-c0871e8c420a",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "435d949f-df4f-4d20-9641-a2515c3cb533",
        "_parent_code": "sample string 6",
        "sales_organization_id": "78184e61-2ecc-49d9-9719-65dd61198661",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
          "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
          "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
          "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-02-03T21:05:17.6756122+00:00"
        },
        "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
      },
      "equipment_model_id": "7833911e-6d9b-4703-8f02-f368b3459656",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "d51f417d-8f83-4922-9690-ba076dba8c78",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "9ae98e28-b601-49c4-ba43-5c40d30a61ef",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "ff9cb9a9-e291-43b1-962a-59810d57ff0f",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "aa47bf45-383f-42d1-964b-5ff0896768d7",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
            "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
            "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
            "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-02-03T21:05:17.6756122+00:00"
          },
          "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
        },
        "equipment_family_id": "14822f05-9f3a-4854-a10a-e86adce14de6",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "824d1c8c-f4c9-4f58-a286-c0871e8c420a",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "435d949f-df4f-4d20-9641-a2515c3cb533",
          "_parent_code": "sample string 6",
          "sales_organization_id": "78184e61-2ecc-49d9-9719-65dd61198661",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
            "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
            "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
            "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-02-03T21:05:17.6756122+00:00"
          },
          "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
        },
        "date_in_production_since": "2026-02-03T21:05:17.6756122+00:00",
        "date_out_of_production_since": "2026-02-03T21:05:17.6756122+00:00",
        "date_end_support": "2026-02-03T21:05:17.6756122+00:00",
        "sales_organization_id": "4052f492-1679-4bb3-839b-e605a8919347",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
          "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
          "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
          "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-02-03T21:05:17.6756122+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-02-03T21:05:17.6756122+00:00"
      },
      "project_status_id": "a7f1cb9d-1153-4926-b0cd-78202876bb22",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "2904c83a-ecbb-4d0c-b900-a3c98075c052",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "fbf39d1d-c293-4c8f-9d62-e98037a92e46",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
          "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
          "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
          "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-02-03T21:05:17.6756122+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
      },
      "company_id": "09e8195a-479e-4e36-a367-664d8cb1096f",
      "company_code": "sample string 12",
      "db_address_id": "c9297a95-acf2-4b1a-ad8a-a7bb7230057b",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "8574ce85-6b79-47dd-9afe-3fa847940a48",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "58e64c82-c45d-4a37-9097-7396e74a2510",
      "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-02-03T21:05:17.6756122+00:00",
      "date_create": "2026-02-03T21:05:17.6756122+00:00",
      "date_update": "2026-02-03T21:05:17.6756122+00:00",
      "updated_by_user_id": "bfc362f0-8590-49df-9e60-f04d8163b53c",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-02-03T21:05:17.6756122+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-02-03T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-02-03T21:05:17.6756122+00:00",
      "date_last_job": "2026-02-03T21:05:17.6756122+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-02-03T21:05:17.6756122+00:00",
      "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "8de3f760-5f7e-48b2-b600-905f10d257c6",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "4fde8a52-6d82-4f28-b542-7e1cf5618dca",
      "name": "sample string 2",
      "sales_organization_id": "25561f78-621a-45ec-bc5f-7a887dcac961",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "c63151cb-a7dd-4990-9226-b0331a72da7b",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c265c1f0-a4d7-4e5c-931b-b420747ee364",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "fab7e311-0e19-4595-bf9a-eaf62be473f8",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
        "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
        "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
        "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-02-03T21:05:17.6756122+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
    },
    "job_status_id": "e9e10ffb-a91a-4000-9af1-18586b3271f5",
    "job_status_code": "sample string 11",
    "db_address_id": "8e29cf2e-127a-401d-aa5b-4b23602d49f1",
    "contact_id": "85ae833f-cec7-4e0e-9959-248f49ed446f",
    "requested_by_company_id": "573b1723-652e-4511-8ff0-804f5b87d5d9",
    "requested_by_contact_id": "7fc66fbf-bfb0-41c9-b250-6df89b2e2052",
    "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-02-03T21:05:17.6756122+00:00",
    "due_date": "2026-02-03T21:05:17.6756122+00:00",
    "date_create": "2026-02-03T21:05:17.6756122+00:00",
    "date_update": "2026-02-03T21:05:17.6756122+00:00",
    "date_closed": "2026-02-03T21:05:17.6756122+00:00",
    "suggested_user_id": "4514244a-1bf0-4fdc-9090-51f958ba8cab",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "50b8f987-52e5-4543-9c6e-3e44ef190d7f",
      "db_language_id": "f2e5655c-053b-4a6f-8b0d-c5d9149d313c",
      "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-02-03T21:05:17.6756122+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "ae32caa1-db9b-4f26-81c3-0a68b3bf10da",
      "sales_organization": {
        "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
        "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
        "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
        "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-02-03T21:05:17.6756122+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "b7bd3b9c-15e8-4ebd-9b74-96ef1d3b7890",
      "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": "dc5cf011-c5cc-406d-9ac6-5a04550a12d6",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "da3b8d09-1401-49e9-8ada-d7f9520f2342"
    },
    "suggested_date_start": "2026-02-03T21:05:17.6756122+00:00",
    "skill_id": "92656bd6-5529-4b84-a4aa-21c95acad5be",
    "skill_code": "sample string 32",
    "skill": {
      "id": "aba1276a-c9eb-4ebd-a63b-898b76befb49",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "5c338aa8-d3fe-4735-a354-c70974837d16",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "ec5d712a-7896-457b-b5b2-db0d841163c5",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "2581a1f5-9e31-404e-a9ea-55d872cfdd9f",
        "db_currency_id": "391ef2e5-441d-4ab7-b3dc-62e72636dde5",
        "db_language_id": "9dd7b30a-3661-42e1-8405-28d965605e9e",
        "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-02-03T21:05:17.6756122+00:00"
      },
      "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "90cbe1d5-e473-4215-bba8-aa29fca8dbf0",
    "date_reported_by_company": "2026-02-03T21:05:17.6756122+00:00",
    "id2": 36,
    "company_id": "f0d85930-0dc8-4e37-b136-12281dc1c591",
    "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": "1f7fd17d-0d6b-4aed-bae8-871bbfdc835b",
    "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-02-03T21:05:17.6756122+00:00"
  },
  "work_instruction_details_id": "c361e3ff-1a7a-45dd-8bce-4296b5f712f3",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "8cb227b1-1343-4565-ad40-bf7b3f275cbc",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "59cb4d05-ab09-4b5c-8e46-3c5552499cbd",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-02-03T21:05:17.6756122+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": "be7f95d8-1c6b-4137-add4-0aaa7a0b60f4",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-02-03T21:05:17.6756122+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.