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": "3626b5bd-31e8-49af-a4c9-3e12e8c9290a",
  "jobs_id": "1f3162ae-d558-43f2-93e1-99019df2ac78",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "14c73173-4e9d-46f8-a918-750d81ec29d4",
    "_parent_id": "37fcdd2b-6adc-4340-a013-02dd82bb3d9b",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "aeacf9f8-1534-4cf4-9290-6ebd1409091f",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "539918a4-7104-4422-866a-aa67bc85cc8c",
      "_parent_id": "4949eb41-f647-4728-bf16-4edf1a76ce39",
      "root_parent_id": "3e92acd0-63c8-42bb-85bf-d160cd152d9d",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "4762bcc2-7e2a-453d-9ab6-b9ed14c39edd",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "53586f28-7027-4e0a-82da-bf38c384b83d",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "328249a0-1408-405a-ae98-5c21b9f56343",
        "_parent_code": "sample string 6",
        "sales_organization_id": "bb0463ea-904c-402a-b63c-587549b347c8",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "849a8965-87ba-479b-a420-550c7fd52dca",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
          "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
          "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
          "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-15T07:24:28.8086099+00:00"
        },
        "modified_dateutc": "2026-02-15T07:24:28.8086099+00:00"
      },
      "equipment_model_id": "f892e671-6f03-4645-8376-dc6ef4185948",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "226b067c-9e68-45d6-8b69-9b7ff6ad502f",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "432136e9-e2b0-4138-a2be-34c5826a2262",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "78472941-29b7-4605-a9f0-e0d3bd38afd5",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "aa53cfd4-f6e9-48cb-9d4a-962aa8331d2e",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "849a8965-87ba-479b-a420-550c7fd52dca",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
            "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
            "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
            "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-15T07:24:28.8086099+00:00"
          },
          "modified_dateutc": "2026-02-15T07:24:28.8086099+00:00"
        },
        "equipment_family_id": "8b634eb1-c492-4757-87a6-4225affbc64c",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "53586f28-7027-4e0a-82da-bf38c384b83d",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "328249a0-1408-405a-ae98-5c21b9f56343",
          "_parent_code": "sample string 6",
          "sales_organization_id": "bb0463ea-904c-402a-b63c-587549b347c8",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "849a8965-87ba-479b-a420-550c7fd52dca",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
            "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
            "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
            "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-15T07:24:28.8086099+00:00"
          },
          "modified_dateutc": "2026-02-15T07:24:28.8086099+00:00"
        },
        "date_in_production_since": "2026-02-15T07:24:28.8086099+00:00",
        "date_out_of_production_since": "2026-02-15T07:24:28.8086099+00:00",
        "date_end_support": "2026-02-15T07:24:28.8086099+00:00",
        "sales_organization_id": "70961c22-f1a1-4d4b-a388-e66442eefd41",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "849a8965-87ba-479b-a420-550c7fd52dca",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
          "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
          "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
          "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-15T07:24:28.8086099+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-15T07:24:28.8242374+00:00"
      },
      "project_status_id": "447a57b9-a40c-43c8-b010-c0aeeca5fa7e",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "9b3ebf7a-3e53-4f6b-8fe7-71d8c985ef96",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "90cb6bac-7cc5-4df8-9c0c-ebd8521daee6",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "849a8965-87ba-479b-a420-550c7fd52dca",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
          "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
          "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
          "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-15T07:24:28.8086099+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00"
      },
      "company_id": "6caae1bf-41ef-45d1-8d24-1b79efa153af",
      "company_code": "sample string 12",
      "db_address_id": "380d9877-43ad-4e96-a3d8-0d2dcd47b7a9",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "3626bcb2-6b41-45b1-a4cb-bd46a2d49c46",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "d6068499-68ff-4d8e-8a35-bf802dc21434",
      "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-15T07:24:28.8242374+00:00",
      "date_create": "2026-02-15T07:24:28.8242374+00:00",
      "date_update": "2026-02-15T07:24:28.8242374+00:00",
      "updated_by_user_id": "1d11d823-8c20-42da-94bf-41992e255f32",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-02-15T07:24:28.8242374+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-15T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-02-15T07:24:28.8242374+00:00",
      "date_last_job": "2026-02-15T07:24:28.8242374+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-02-15T07:24:28.8242374+00:00",
      "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "33fdb2cf-1526-4127-aea2-6a31ade4596e",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "9a0df98f-9801-42b8-a7ff-1fde016f5434",
      "name": "sample string 2",
      "sales_organization_id": "c518680f-812c-4d26-bc3a-14b591468233",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "8bfbab4e-fb4e-4b6a-9d59-89b76d19d0cd",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "900f63f1-fcfc-45c2-8547-855ba1eec71a",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "3aeeb8ee-c33c-432d-9139-36d20074e1e2",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "849a8965-87ba-479b-a420-550c7fd52dca",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
        "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
        "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
        "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-15T07:24:28.8086099+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00"
    },
    "job_status_id": "9c35825f-e552-4576-b367-8e1d0151f3c7",
    "job_status_code": "sample string 11",
    "db_address_id": "5fc89b64-8898-4569-9fc0-042bb72e99f7",
    "contact_id": "2a54f0d5-7a71-4fcf-8881-727867caae68",
    "requested_by_company_id": "3a1d9754-0dfb-4552-8bf4-ca7f76ec8c2f",
    "requested_by_contact_id": "84466e2e-f53a-48e0-9063-dcf22f43e64c",
    "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-15T07:24:28.8242374+00:00",
    "due_date": "2026-02-15T07:24:28.8242374+00:00",
    "date_create": "2026-02-15T07:24:28.8242374+00:00",
    "date_update": "2026-02-15T07:24:28.8242374+00:00",
    "date_closed": "2026-02-15T07:24:28.8242374+00:00",
    "suggested_user_id": "9d02d7cb-c07e-461e-9061-1aa09cf03877",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "9ee344a2-5bc6-4165-9cf8-bcc66874966e",
      "db_language_id": "2d2fb1e9-e7b7-4996-8994-c0598a21445e",
      "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-15T07:24:28.8242374+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "f9ca22e2-193e-4550-abc0-3aa8269553dc",
      "sales_organization": {
        "id": "849a8965-87ba-479b-a420-550c7fd52dca",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
        "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
        "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
        "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-15T07:24:28.8086099+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "7ee7b5be-d105-4158-828b-f975c1ebc851",
      "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": "cf5289c7-d64c-411c-ac7c-8434f225670e",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "02911eb8-1798-4028-a4d2-0b8af28ef2d0"
    },
    "suggested_date_start": "2026-02-15T07:24:28.8242374+00:00",
    "skill_id": "d9a0e669-0ed3-4f8d-8dca-d22aa333e5e5",
    "skill_code": "sample string 32",
    "skill": {
      "id": "4b20c6b7-0f5b-491f-8f6b-595c20b3585b",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "606f630e-c54a-400b-bd73-eb4f20591087",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "849a8965-87ba-479b-a420-550c7fd52dca",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "73a883a7-e6ba-40f9-8c7a-26d7dcb39038",
        "db_currency_id": "0cd05216-2581-441d-97d1-5c8ce4b90a0a",
        "db_language_id": "8507e3cd-fc21-4974-836a-763b7cac8ad2",
        "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-15T07:24:28.8086099+00:00"
      },
      "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "509e2808-4a66-4040-a950-376a6d1a47ec",
    "date_reported_by_company": "2026-02-15T07:24:28.8242374+00:00",
    "id2": 36,
    "company_id": "8a472864-4921-4b55-92da-c7d6c3f66291",
    "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": "4e1aa8b0-babf-4d6a-8584-79b1114dca02",
    "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-15T07:24:28.8242374+00:00"
  },
  "work_instruction_details_id": "705c8851-6b4d-4da2-b2a4-f443851b6104",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "cc43f959-3c17-436d-9204-ab81f7bed839",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "a2db62da-670e-461a-bf0b-ac9a00f89660",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-02-15T07:24:28.8242374+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": "4ce9c3b6-8de6-4d8f-ae37-67c9e39bbd23",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-02-15T07:24:28.8242374+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.