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": "069fa68e-4f0b-439d-a1db-1ebdc8be2848",
  "jobs_id": "a4e9586f-6b15-4793-9b70-ee7c6fd1654d",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "0cbc91a6-1652-4603-b862-d0688f2d18ac",
    "_parent_id": "79cdc22b-4f46-4890-b7a0-01a48de74203",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "ca5b8864-58a8-4abc-807b-4e98bc1a1a3f",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "886995d6-92fd-4afd-af36-bdf31c4ec087",
      "_parent_id": "bcae23a0-332c-4fc6-b32d-11e5d48264cc",
      "root_parent_id": "01b828d3-de99-4133-a245-1109a8c58285",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "c5166086-6b7b-4614-9215-626dba3ca56b",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "384fe391-c429-4417-be95-28874ff0cf91",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "db423ce7-c0cd-47cf-a88a-8263b2836881",
        "_parent_code": "sample string 6",
        "sales_organization_id": "d6993047-f379-4459-a816-5986191bcef3",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "27214558-d117-4af0-a47d-b018f45f311a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
          "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
          "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
          "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-19T18:39:10.0873906+00:00"
        },
        "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
      },
      "equipment_model_id": "ae49aa6f-3c41-44ce-984c-e76ee4cece3b",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "50e40002-2b74-4294-b4f9-c38ed4eabed7",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "8ed88d20-8d25-4796-9438-75c07d09bb5c",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "379e2c9c-309c-4721-b238-f1d36668e195",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "149e1a65-2037-4ab5-8939-f610692186c2",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "27214558-d117-4af0-a47d-b018f45f311a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
            "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
            "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
            "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-19T18:39:10.0873906+00:00"
          },
          "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
        },
        "equipment_family_id": "f2e43032-9165-476d-b899-030e10807580",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "384fe391-c429-4417-be95-28874ff0cf91",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "db423ce7-c0cd-47cf-a88a-8263b2836881",
          "_parent_code": "sample string 6",
          "sales_organization_id": "d6993047-f379-4459-a816-5986191bcef3",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "27214558-d117-4af0-a47d-b018f45f311a",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
            "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
            "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
            "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-19T18:39:10.0873906+00:00"
          },
          "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
        },
        "date_in_production_since": "2026-11-19T18:39:10.0873906+00:00",
        "date_out_of_production_since": "2026-11-19T18:39:10.0873906+00:00",
        "date_end_support": "2026-11-19T18:39:10.0873906+00:00",
        "sales_organization_id": "1321c700-20d4-42e7-afba-f88f40ba2a4c",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "27214558-d117-4af0-a47d-b018f45f311a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
          "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
          "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
          "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-19T18:39:10.0873906+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-19T18:39:10.0873906+00:00"
      },
      "project_status_id": "625fc30d-4cc8-46b1-b077-c7a56373d04b",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "25cbb167-62d9-4eb3-97b3-cdcc1df15b0a",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "8faccba3-c6aa-4fb7-95b7-5e70d11ad924",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "27214558-d117-4af0-a47d-b018f45f311a",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
          "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
          "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
          "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-19T18:39:10.0873906+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
      },
      "company_id": "02607801-f9b7-41c7-b5ff-4ee5cfb38575",
      "company_code": "sample string 12",
      "db_address_id": "6935527f-0ead-4655-b868-812d84f3a121",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "3da02ade-7511-41a7-a590-5546b203662c",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "cfcdf4af-b8a3-4518-9409-e1153ba44801",
      "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-19T18:39:10.0873906+00:00",
      "date_create": "2026-11-19T18:39:10.0873906+00:00",
      "date_update": "2026-11-19T18:39:10.0873906+00:00",
      "updated_by_user_id": "f93ad364-b3d7-4344-9ca8-a2821c30c2af",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-19T18:39:10.0873906+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-19T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-19T18:39:10.0873906+00:00",
      "date_last_job": "2026-11-19T18:39:10.0873906+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-19T18:39:10.0873906+00:00",
      "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "0d76ec0c-2b52-470f-858e-25f28b57bd7c",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "3c44de60-2122-4c66-8909-43ae32e48999",
      "name": "sample string 2",
      "sales_organization_id": "a59b7305-5282-4e27-a902-64121ae07176",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "618237d6-2d54-463b-989a-21c25459aa00",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "d39104c9-547f-4c5e-a5cf-209ddc021ceb",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "881d6fe4-5d34-41bb-be10-2fb29d7cc2fa",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "27214558-d117-4af0-a47d-b018f45f311a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
        "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
        "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
        "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-19T18:39:10.0873906+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
    },
    "job_status_id": "7e579d50-4099-4e47-aa3d-ca7f619ea138",
    "job_status_code": "sample string 11",
    "db_address_id": "107d2583-8c8a-4689-b46c-d1da9815ff91",
    "contact_id": "f197bd2a-23fb-4915-aae7-079136d9dd12",
    "requested_by_company_id": "d458bcb2-c02d-43c0-83b5-5f3b8986c433",
    "requested_by_contact_id": "5889256d-f1cf-45bb-965a-f48cee36d00f",
    "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-19T18:39:10.0873906+00:00",
    "due_date": "2026-11-19T18:39:10.0873906+00:00",
    "date_create": "2026-11-19T18:39:10.0873906+00:00",
    "date_update": "2026-11-19T18:39:10.0873906+00:00",
    "date_closed": "2026-11-19T18:39:10.0873906+00:00",
    "suggested_user_id": "de143419-56ef-4c8e-b07a-54439dde3c31",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "f42a67ed-5ff3-4223-a939-265c4b1611f2",
      "db_language_id": "71a9f55c-0035-456c-9471-5b2d26db0a38",
      "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-19T18:39:10.0873906+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "0e246f57-e17e-4e04-84ac-99c2f435ed53",
      "sales_organization": {
        "id": "27214558-d117-4af0-a47d-b018f45f311a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
        "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
        "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
        "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-19T18:39:10.0873906+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "abb7ad1b-fda5-45da-a8ee-cf7bb6dfbf53",
      "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": "5f812aae-dc23-4972-9cb9-d3c41ff33af9",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "db872a33-36ea-4af1-8165-c7562e594eee"
    },
    "suggested_date_start": "2026-11-19T18:39:10.0873906+00:00",
    "skill_id": "7e9d9238-3d2d-4f82-97e6-a5ca7a606ff0",
    "skill_code": "sample string 32",
    "skill": {
      "id": "ae37634a-b50c-48a3-85f3-943333028a3c",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "96cd30a4-e8bb-4c8c-9703-28d34f74e77f",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "27214558-d117-4af0-a47d-b018f45f311a",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "fd5dbee0-19c8-40d6-bb32-b1d77027e944",
        "db_currency_id": "dd44adb2-85aa-4f4f-8c10-0c84e90fe38e",
        "db_language_id": "843b389b-7ec9-43b6-abb5-ea26917119cf",
        "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-19T18:39:10.0873906+00:00"
      },
      "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "bf7088ec-8557-4238-a084-9697f2a565b5",
    "date_reported_by_company": "2026-11-19T18:39:10.0873906+00:00",
    "id2": 36,
    "company_id": "d1994938-e58a-4d87-8d73-cdb79f71a62b",
    "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": "746b8a99-1a53-4d3e-8e2c-38b26192f513",
    "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-19T18:39:10.0873906+00:00"
  },
  "work_instruction_details_id": "c83fc246-0db1-4901-8bfb-f03eb6cf7be8",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "02699ce0-1e8a-4d7d-8516-3fe908a9fb3d",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "1c5af585-9dc2-40e5-9c2e-444af45398fa",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-19T18:39:10.0873906+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": "49fab08b-41c4-4698-9f0a-2308eac9527c",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-19T18:39:10.0873906+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.