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": "5d2a97cc-9bb2-49b7-b129-424995146578",
"jobs_id": "986145d1-739c-44bb-9656-1113175ea1d9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f0bd154e-cca4-41aa-b47a-b93cd3a7d3c7",
"_parent_id": "27d06654-29cc-454b-80a2-33d5b1df9a3e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b9ff1ba-44bc-43c4-9899-7b59730b05b3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7977425e-5372-4e9c-9ea3-44cca877097f",
"_parent_id": "6664cd5c-b1e7-4d93-b086-71adbb2f414c",
"root_parent_id": "efa4b0f1-7d23-4e5d-a126-b0b0229d8ff1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "02fae685-3c66-4f10-9c3e-e71571f1e644",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ba436a7e-b5e6-487f-a066-372a59d51b04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c4540c43-7884-4297-ba85-1ce82bc9861b",
"_parent_code": "sample string 6",
"sales_organization_id": "d687ee12-48bf-4236-8b42-1362f52caa60",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00"
},
"equipment_model_id": "7a6fb83d-0888-4a41-998b-fbcc1ea6cfdc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "07455d03-59ba-4845-a022-3777ca08e3a5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "5dc38629-cd6c-4b01-9a90-dd25fc3ddb86",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ebda2fb0-a97e-43a3-a809-2d0b70dbaef1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "7ce3f434-1933-4828-8560-1c20e46926ba",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00"
},
"equipment_family_id": "bb05569c-3339-4c96-9ae8-15b68795a833",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ba436a7e-b5e6-487f-a066-372a59d51b04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c4540c43-7884-4297-ba85-1ce82bc9861b",
"_parent_code": "sample string 6",
"sales_organization_id": "d687ee12-48bf-4236-8b42-1362f52caa60",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00"
},
"date_in_production_since": "2025-11-05T08:18:02.7803186+00:00",
"date_out_of_production_since": "2025-11-05T08:18:02.7803186+00:00",
"date_end_support": "2025-11-05T08:18:02.7803186+00:00",
"sales_organization_id": "370aa9d5-7815-43c6-8f7f-c2d2bd065f7d",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+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": "2025-11-05T08:18:02.7803186+00:00"
},
"project_status_id": "9bef9282-59b7-4fc9-a708-d3c5cee9a2ea",
"project_status_code": "sample string 10",
"project_status": {
"id": "d68a41a1-18ca-43f5-a262-2567258b0791",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "0ba0d465-f080-43f4-885d-43428ba1610c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00"
},
"company_id": "5836ee2f-ff3c-4d72-b4fe-f68aae911efa",
"company_code": "sample string 12",
"db_address_id": "89a908fe-9233-4938-8a90-72cf8498814e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dda08141-4c6e-4373-a0bd-7a3474fcf99f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7231104f-bcaf-4130-808e-774818553a21",
"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": "2025-11-05T08:18:02.7803186+00:00",
"date_create": "2025-11-05T08:18:02.7803186+00:00",
"date_update": "2025-11-05T08:18:02.7803186+00:00",
"updated_by_user_id": "1c2b3866-8139-4fbe-83aa-a399d58784e6",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-05T08:18:02.7803186+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": "2025-11-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-05T08:18:02.7803186+00:00",
"date_last_job": "2025-11-05T08:18:02.7803186+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-05T08:18:02.7803186+00:00",
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00",
"is_mobile_installation": true
},
"job_type_id": "4e0f1e34-c737-45dc-88e5-cda5a901f11b",
"job_type_code": "sample string 7",
"job_type": {
"id": "8a53ff39-4d81-4268-8f71-b3bfb555cb69",
"name": "sample string 2",
"sales_organization_id": "6ab3538b-c621-44f5-b49c-29b6cdc9f031",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-05T08:18:02.7803186+00:00",
"code": "sample string 7"
},
"job_priority_id": "47c4fd30-71ad-48c7-b0cb-bb397b1bf568",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f552376d-780d-443a-8206-97d6281c0fd7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9d98ba6b-ef66-4165-86a1-64c6f96d57af",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-05T08:18:02.7959485+00:00"
},
"job_status_id": "8b825f07-34c0-499d-8f18-b899d3797ca6",
"job_status_code": "sample string 11",
"db_address_id": "2b3c15a2-270e-49ed-8763-5abac1bfae70",
"contact_id": "3c455813-49e4-47ac-b71f-58ebc857a031",
"requested_by_company_id": "607dda71-c56e-494f-b9fe-82c35550b2f4",
"requested_by_contact_id": "84b2508c-1583-423b-b6e6-d84d803cb338",
"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": "2025-11-05T08:18:02.7959485+00:00",
"due_date": "2025-11-05T08:18:02.7959485+00:00",
"date_create": "2025-11-05T08:18:02.7959485+00:00",
"date_update": "2025-11-05T08:18:02.7959485+00:00",
"date_closed": "2025-11-05T08:18:02.7959485+00:00",
"suggested_user_id": "1758e086-64e5-42a2-bfe1-dd51f31c1ab7",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0d380404-eab8-49da-a8ab-bbe430f7b5e3",
"db_language_id": "8a755673-1dc4-4847-a860-ce7d9223a043",
"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": "2025-11-05T08:18:02.7959485+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "12e14c56-3220-4f58-b05d-3b9200fa0d3b",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "62224105-350f-42da-bd21-c68d245f0d83",
"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": "8c1992c1-3f66-435b-8297-1898a22b9dbc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-05T08:18:02.7959485+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "30296efb-7309-4cb6-9a3f-af9eea682b7d"
},
"suggested_date_start": "2025-11-05T08:18:02.7959485+00:00",
"skill_id": "9e785797-5b0d-43cf-ba05-726459c2ba79",
"skill_code": "sample string 32",
"skill": {
"id": "7748012b-2dd1-40e9-bfb8-35420fe0a3b7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e3157639-6568-479b-85b4-0c40e1f07306",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "35b641e9-77df-4e50-981a-d900984ac575",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "351b4f66-0f54-4421-bfa6-936c7688ca9c",
"db_currency_id": "d1b40cf0-c3be-486c-a40b-da4f823827a9",
"db_language_id": "4aeb289c-5415-4065-83f7-476b22321885",
"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": "2025-11-05T08:18:02.7803186+00:00"
},
"modified_dateutc": "2025-11-05T08:18:02.7959485+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "13244130-d3f8-4888-bbd5-b07c018828bb",
"date_reported_by_company": "2025-11-05T08:18:02.7959485+00:00",
"id2": 36,
"company_id": "180501f7-2630-4d2b-8857-01db7cfe1246",
"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": "a31c3a05-e035-4fb0-889a-886fdf89da03",
"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": "2025-11-05T08:18:02.7959485+00:00"
},
"work_instruction_details_id": "54c20f08-358d-42a8-8f59-8b52e38d0a7a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "775bed8c-09ac-4551-9d61-b98855e90894",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5bffb33b-8755-4c2a-a628-60d74dedf636",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-05T08:18:02.7959485+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": "45d4d8b5-f181-4c8a-8457-4bf1c2b0914f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-05T08:18:02.7959485+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.