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": "27c56d6a-7130-4b76-b9da-3232fa444e12",
"jobs_id": "a9fcc449-6a74-472a-b928-dbc654d5f493",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "13cf627f-e861-46e4-a89f-a99e88ecbb0f",
"_parent_id": "3c79ddf0-c114-452f-9646-4913f361c737",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b8a2435b-cfc0-4d9d-bf96-b203168d41d4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "772fe7fb-9802-4726-a4f9-31e905ca5b97",
"_parent_id": "074ede18-9f71-4199-8d82-d8e880d7877b",
"root_parent_id": "6ada151c-e647-440b-9dd8-ad04709d37c3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ae8e10c9-36aa-4d1c-ab02-293952bc2750",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b54b7c9d-6788-40d1-8684-a5e83d441860",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24fe0bc2-dbd0-4e47-a6ad-ac7a1aa80a96",
"_parent_code": "sample string 6",
"sales_organization_id": "66b261ab-3f8b-4e0d-a0af-41716963ebdd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"equipment_model_id": "34834b8c-bfcf-4a0b-9ae1-d4431b86f786",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e9a38b87-8883-419d-a36e-b8b750733589",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "637eb715-2b49-48d0-8408-dc056cd7a361",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8736a379-b90b-4286-aba3-08c99ee023e6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6c7e8991-8d64-4be7-bf4f-7bda4823a566",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"equipment_family_id": "d722347b-b538-4a51-a2f7-e04d38c1b49c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b54b7c9d-6788-40d1-8684-a5e83d441860",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24fe0bc2-dbd0-4e47-a6ad-ac7a1aa80a96",
"_parent_code": "sample string 6",
"sales_organization_id": "66b261ab-3f8b-4e0d-a0af-41716963ebdd",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"date_in_production_since": "2026-09-18T05:39:19.14654+00:00",
"date_out_of_production_since": "2026-09-18T05:39:19.14654+00:00",
"date_end_support": "2026-09-18T05:39:19.14654+00:00",
"sales_organization_id": "cfecb37f-0766-400a-b186-cf409caeec10",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+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-09-18T05:39:19.14654+00:00"
},
"project_status_id": "373fd39e-5f16-4894-a6ab-083a252f17a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "17222720-e689-4af2-b84c-7e83845e5ee5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f8037bbf-7617-42ad-ab3c-a69bf25dc37d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"company_id": "6900c1bc-ba8c-4ef4-bbe0-d03979dd76bd",
"company_code": "sample string 12",
"db_address_id": "b60a2afa-b4df-4ee0-9623-1a1e40b23f33",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7f073b28-d430-465c-9181-caebbcea5f6d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "166138d1-3cd2-4ef5-b458-bb3994486d9a",
"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-09-18T05:39:19.14654+00:00",
"date_create": "2026-09-18T05:39:19.14654+00:00",
"date_update": "2026-09-18T05:39:19.14654+00:00",
"updated_by_user_id": "e301981b-ae1e-4b1c-8326-56c00721e525",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T05:39:19.14654+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-09-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T05:39:19.14654+00:00",
"date_last_job": "2026-09-18T05:39:19.14654+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T05:39:19.14654+00:00",
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00",
"is_mobile_installation": true
},
"job_type_id": "a51840a5-d7c0-42d5-97b6-8d303d33bf10",
"job_type_code": "sample string 7",
"job_type": {
"id": "be40e030-502e-4ef5-ad13-46b8c40bce6f",
"name": "sample string 2",
"sales_organization_id": "e25ea16e-39b4-47c9-bbca-6e450848700c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00",
"code": "sample string 7"
},
"job_priority_id": "8da4a623-b3f4-4349-b4fb-903823485218",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a4450772-b05a-4d81-b873-d39d59a0e293",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "407c8b78-7e4d-49ce-952d-295aaae46c23",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"job_status_id": "a42211e0-51af-4cdd-bcb3-ee47f1d520bf",
"job_status_code": "sample string 11",
"db_address_id": "f2888731-f620-4d99-a878-6c3eb85e020c",
"contact_id": "37d8ed11-f246-4b3d-87be-fd5a39d78669",
"requested_by_company_id": "348aecf8-842f-4ada-a43b-b5ddf4d3b93a",
"requested_by_contact_id": "67f54aae-de28-4689-b331-c4f165be4b53",
"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-09-18T05:39:19.14654+00:00",
"due_date": "2026-09-18T05:39:19.14654+00:00",
"date_create": "2026-09-18T05:39:19.14654+00:00",
"date_update": "2026-09-18T05:39:19.14654+00:00",
"date_closed": "2026-09-18T05:39:19.14654+00:00",
"suggested_user_id": "e0c3b9bc-f26d-43d2-8b31-50408054d391",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1d766d27-fc28-4ea5-8f4d-55029bd7fcf2",
"db_language_id": "c7b19672-e419-46c3-8b58-c8116d766bd9",
"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-09-18T05:39:19.14654+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0149b93a-d9f4-44f4-aeee-ce5b94d87b73",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b65c53df-6fc2-459f-8692-9915f5b991f6",
"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": "154a7f3d-55bd-43fe-ae07-fa046631076a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4c4cd78d-cc18-4146-bc7f-19860701f7d9"
},
"suggested_date_start": "2026-09-18T05:39:19.14654+00:00",
"skill_id": "d3587259-62ab-49a5-b69a-6dc02b65d8d6",
"skill_code": "sample string 32",
"skill": {
"id": "6b87d576-c482-4f45-8bcd-9bb358ad7f35",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "edfe93cd-2702-40c1-9383-1dc3176ca5c5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dc3adc9f-4ba1-4c41-932f-4ebb345b0510",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ea4c2ef-3055-4677-86b2-99370c9767c8",
"db_currency_id": "a6bd6a80-6c0d-42a5-bedd-a9cb883f38ac",
"db_language_id": "6eba6770-d7f6-47a2-9927-29be09d927cb",
"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-09-18T05:39:19.14654+00:00"
},
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a00b8695-55de-4579-9c76-ac428c8e7b7c",
"date_reported_by_company": "2026-09-18T05:39:19.14654+00:00",
"id2": 36,
"company_id": "3dffcdaa-1c90-4a59-acc4-c5c9571a2ab6",
"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": "b6f758e1-4188-4825-a5f7-1ac24d122337",
"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-09-18T05:39:19.14654+00:00"
},
"work_instruction_details_id": "71d976e4-08c6-4032-87ce-b44fc892d6ca",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "aa49e255-1105-4655-b5a7-68af2b873971",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bc60be69-3141-4274-891f-a6c557e0a990",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T05:39:19.14654+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": "aaa4b262-e8c2-4b13-a162-ca24dd72710f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T05:39:19.14654+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.