Updates the job work instruction list with the specified key
Request Information
URI Parameters :
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters :
job_work_instruction_list| Name | Description | Type | Additional 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": "01feaa31-f4a8-421e-8dfc-f14c5c893536",
"jobs_id": "e815c320-4b93-4497-90ab-654b6ad1d20b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c5401807-6d7a-4709-9799-29b429542665",
"_parent_id": "be243fd3-513b-4adb-87fc-0fc18440a7f0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7aa157d0-7cf0-431d-b1e0-73d08e0b5f98",
"project_reference_back_office": "sample string 5",
"project": {
"id": "86a0d7f2-9e38-4b81-b4f3-20d90a08e336",
"_parent_id": "e557983b-1bc3-4625-97fa-dba97401da94",
"root_parent_id": "186ac807-e8d8-4d84-8a0d-d8405d2ea079",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c9c9458b-c9d1-4e22-b19e-79f377ff3265",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eef26872-e2e6-4e53-8cca-6a68188c7c33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "940488ae-9dd8-4fc4-aa6c-27cd77dcd3a9",
"_parent_code": "sample string 6",
"sales_organization_id": "74754342-08fe-4af9-8e4a-7ddb799a7200",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"equipment_model_id": "839c5417-8518-4fb8-a908-819c7d1df629",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0d50f6fa-7457-4e5a-9676-fd82bb9df7fc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "73466633-1382-45bf-a02c-ac9245b8140e",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "35fc5b5f-5071-4bc4-ab27-d313b18021d5",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "14475e1f-6d07-4ead-b3fc-9e3117209852",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"equipment_family_id": "1510e8ee-042a-430f-bff6-9a8374b4b908",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eef26872-e2e6-4e53-8cca-6a68188c7c33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "940488ae-9dd8-4fc4-aa6c-27cd77dcd3a9",
"_parent_code": "sample string 6",
"sales_organization_id": "74754342-08fe-4af9-8e4a-7ddb799a7200",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"date_in_production_since": "2026-08-21T21:37:59.9372037+00:00",
"date_out_of_production_since": "2026-08-21T21:37:59.9372037+00:00",
"date_end_support": "2026-08-21T21:37:59.9372037+00:00",
"sales_organization_id": "35926511-c484-4d1f-a8f0-741815d38682",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+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-08-21T21:37:59.9372037+00:00"
},
"project_status_id": "11b22e93-94e6-4330-981a-2c7666eeeb9d",
"project_status_code": "sample string 10",
"project_status": {
"id": "3e9f0334-2c21-4abb-a7fc-b1476422b413",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "6a0e663d-1d9a-4468-9568-aed0837e6c6e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"company_id": "d3a738f3-71b2-4b15-b31c-4feef9e653c4",
"company_code": "sample string 12",
"db_address_id": "6c46eefd-9aa8-4b43-a02f-e677b5258492",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "25d6e5c2-b54a-46e8-bd59-510efd3c7703",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cb81112e-fe06-48a6-a35e-37de122d73b2",
"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-08-21T21:37:59.9372037+00:00",
"date_create": "2026-08-21T21:37:59.9372037+00:00",
"date_update": "2026-08-21T21:37:59.9372037+00:00",
"updated_by_user_id": "7d22a54f-f377-4da3-95d0-76a15b9106c0",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-21T21:37:59.9372037+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-08-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-21T21:37:59.9372037+00:00",
"date_last_job": "2026-08-21T21:37:59.9372037+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-21T21:37:59.9372037+00:00",
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00",
"is_mobile_installation": true
},
"job_type_id": "19e3970f-ed4e-409a-aefd-9573b886efa7",
"job_type_code": "sample string 7",
"job_type": {
"id": "8683ef2b-1803-4e35-be27-101a6f951d5c",
"name": "sample string 2",
"sales_organization_id": "2b76fffd-8358-431c-a909-c287bc06dd51",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00",
"code": "sample string 7"
},
"job_priority_id": "45d3a98c-eae5-4733-b94e-c11860f6c4e5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0790d6e7-7ff5-410a-a03a-58ed48c56600",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e40e6806-6a50-4674-88c6-acd7d1127f6f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"job_status_id": "dd8e6c0a-86c7-4ccd-b628-1f0ccc81bcc5",
"job_status_code": "sample string 11",
"db_address_id": "5eac2ce2-a907-4155-8bf2-5104bf8793cd",
"contact_id": "3857103a-7fe6-4be8-a55b-4f208623a70e",
"requested_by_company_id": "f93303c0-391b-414e-9334-1ac797d62e96",
"requested_by_contact_id": "74211ca5-154f-4942-bcaf-5418067cd79c",
"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-08-21T21:37:59.9372037+00:00",
"due_date": "2026-08-21T21:37:59.9372037+00:00",
"date_create": "2026-08-21T21:37:59.9372037+00:00",
"date_update": "2026-08-21T21:37:59.9372037+00:00",
"date_closed": "2026-08-21T21:37:59.9372037+00:00",
"suggested_user_id": "1d9e0167-6fa0-43a5-a5db-ae64aba95e4f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "216281a4-c988-49c4-b62c-a1e1fa9cd2ff",
"db_language_id": "cb65228e-d6b0-4239-a8c0-ffe502bf21a1",
"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-08-21T21:37:59.9372037+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d9682ff9-67b1-425f-adae-273373f64363",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "133d82a6-7433-4377-bf4d-6a387895ebd7",
"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": "cbe27310-90ff-43bd-bff1-7a9989cd6523",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b94117aa-808b-4745-9d7b-ab8fef3a84c1"
},
"suggested_date_start": "2026-08-21T21:37:59.9372037+00:00",
"skill_id": "b8b6e9ea-4fd8-44d1-b49b-a91687d2794f",
"skill_code": "sample string 32",
"skill": {
"id": "6930a9b1-d744-4794-a955-5e30975fa3eb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "32fffa87-95fd-47a7-8914-efde29b04c55",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "728c5864-ccec-49b3-b2ac-0087020069d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "faf305fd-6c92-4f4a-9bef-60fad6df7d3f",
"db_currency_id": "1b0cefaa-f346-4b00-9426-092a26c7d23e",
"db_language_id": "225655c1-7d1e-4888-8541-f2a25fec29fe",
"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-08-21T21:37:59.9372037+00:00"
},
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ff0adb75-04a5-42bd-afb3-218f94f7f566",
"date_reported_by_company": "2026-08-21T21:37:59.9372037+00:00",
"id2": 36,
"company_id": "11e377ec-6c78-463e-903e-bfc259cdc7b6",
"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": "a0dc75a5-4950-4195-81b6-4c0dc0437c59",
"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-08-21T21:37:59.9372037+00:00"
},
"work_instruction_details_id": "690f03b2-7b44-496f-8595-55460eedd1dc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "761c2b15-70fc-4b9a-81b3-2ee9e25b7e62",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "0dcbc600-0bba-4c85-9376-ce770ec8c8b7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-21T21:37:59.9372037+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": "2d3c566c-a61f-496d-bf8d-a81b99808f6a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-21T21:37:59.9372037+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.