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": "c8490a52-9fdf-471d-9c14-a14824e66f00",
"jobs_id": "9c08c916-b36d-488e-8435-252861adf7a2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b03e3e18-4c17-4a41-bf7f-ba7a76f0f6ff",
"_parent_id": "5eb3016a-1ed9-4bc4-9f86-39fb136c0eb1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "516473af-bc47-478c-a739-4aca74449b2b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "63352c91-97fd-4a7a-9ce0-241045c244d6",
"_parent_id": "1ca9e9c0-28d3-40a8-9e5c-94543fcc41d3",
"root_parent_id": "87709be4-3b6e-4794-ba8a-39c4ce412d81",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "521a0cd8-752d-4539-b33b-22702b8a9044",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "379146ca-1c17-4c9f-b978-e7cef0edb8b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06f769aa-123e-4447-b654-02419e0b9817",
"_parent_code": "sample string 6",
"sales_organization_id": "07551e96-7e2d-4d91-9a8b-d1c4275b96ec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"equipment_model_id": "89780d01-cde8-4065-9957-964d78cc851e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6dc3862f-b6d5-497a-8d86-b1e906c8e889",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bd4ad6a6-b2e9-4554-a387-ebc5a2990bd6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "628d9e36-60b6-4b04-b5ff-5b498745d0ae",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c4caac96-bf3b-4e6f-8827-2826792642ef",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"equipment_family_id": "cf88c217-fb59-4b4a-9f76-bc81f3469b43",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "379146ca-1c17-4c9f-b978-e7cef0edb8b6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06f769aa-123e-4447-b654-02419e0b9817",
"_parent_code": "sample string 6",
"sales_organization_id": "07551e96-7e2d-4d91-9a8b-d1c4275b96ec",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"date_in_production_since": "2026-08-27T23:07:30.0502212+00:00",
"date_out_of_production_since": "2026-08-27T23:07:30.0502212+00:00",
"date_end_support": "2026-08-27T23:07:30.0502212+00:00",
"sales_organization_id": "ca339dcf-1955-4c9d-bb5b-fb929e87c782",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+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-27T23:07:30.0502212+00:00"
},
"project_status_id": "b16c3ed5-6cb1-455a-b062-40ae7d1d1f62",
"project_status_code": "sample string 10",
"project_status": {
"id": "96079236-4123-4799-a149-540368fd7300",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5054e4f2-45c3-4eb4-94de-ca15bb01884b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"company_id": "b7c35936-8d8a-4742-94ea-cf7a3fe66687",
"company_code": "sample string 12",
"db_address_id": "1d0c4da8-9376-4d1c-a66c-eb0b6b27de63",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3bf41c5a-2fc1-4d37-82fd-9d9cc3de69f7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8d5d31a2-31ce-4326-a9b4-d482f0b63d45",
"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-27T23:07:30.0502212+00:00",
"date_create": "2026-08-27T23:07:30.0502212+00:00",
"date_update": "2026-08-27T23:07:30.0502212+00:00",
"updated_by_user_id": "b4631ed4-ace4-486c-9e70-04fbce133a88",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-27T23:07:30.0502212+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-27T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-27T23:07:30.0502212+00:00",
"date_last_job": "2026-08-27T23:07:30.0502212+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-27T23:07:30.0502212+00:00",
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00",
"is_mobile_installation": true
},
"job_type_id": "efae0598-9b31-4a5f-b9d7-ce7a1701d287",
"job_type_code": "sample string 7",
"job_type": {
"id": "c888bb30-d323-4e3f-8427-ca53d0c19461",
"name": "sample string 2",
"sales_organization_id": "18f47410-936c-4f3f-a962-053a8b207e10",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00",
"code": "sample string 7"
},
"job_priority_id": "9af704e2-4a82-462d-b06b-38d8119c664f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13659ec7-9153-4a48-8f93-3fccecc8ca1f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b15617ad-a149-4c07-b298-05c2ad5b43ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"job_status_id": "b2f3c5bf-cb4f-4964-bea7-98cd35992007",
"job_status_code": "sample string 11",
"db_address_id": "eaa43324-3553-40f3-abed-afb954652b56",
"contact_id": "421f0c1d-e928-4f47-8411-faf2ac832828",
"requested_by_company_id": "cc4655b3-7379-4ec8-87d0-fccf42035a25",
"requested_by_contact_id": "66504a7f-c2da-4670-b272-0916b7722779",
"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-27T23:07:30.0502212+00:00",
"due_date": "2026-08-27T23:07:30.0502212+00:00",
"date_create": "2026-08-27T23:07:30.0502212+00:00",
"date_update": "2026-08-27T23:07:30.0502212+00:00",
"date_closed": "2026-08-27T23:07:30.0502212+00:00",
"suggested_user_id": "11e73317-2a8d-48b5-93d9-efe1c5113714",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e0df115e-430b-4fad-8bfb-d16943a4b817",
"db_language_id": "ccada867-6d11-440d-a424-0237056506dd",
"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-27T23:07:30.0502212+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "04a6fc64-4dd3-45a8-91f2-81c67b785972",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e45617da-2043-4c44-a4a3-2423d70be79f",
"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": "a7be60ef-b2f7-405d-bcc1-d4211e392d85",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d86c0629-e3da-4202-8e76-9e7283ab9e07"
},
"suggested_date_start": "2026-08-27T23:07:30.0502212+00:00",
"skill_id": "93221694-b56f-4041-ae12-649ed88ce351",
"skill_code": "sample string 32",
"skill": {
"id": "fe48e7aa-d44b-4341-9c65-a9a50a16ec26",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "61b0f8bd-305a-4aca-927c-133cf951312c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "bd629bbe-1cfc-4367-b480-78067193abbe",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac52069c-88f7-4708-98f2-2a6c20a7c5e2",
"db_currency_id": "d7f1b9b1-c27e-4cf6-8f8a-1ded0005ae00",
"db_language_id": "cd1fa9a5-891f-4de1-a609-8adfa39d1bd8",
"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-27T23:07:30.0502212+00:00"
},
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6fb13796-e2dc-4dfb-8953-47b7b454ce38",
"date_reported_by_company": "2026-08-27T23:07:30.0502212+00:00",
"id2": 36,
"company_id": "8a3f02e5-8924-4d2d-921c-3eb7bfb7e2cb",
"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": "62f0cb47-a981-47d2-8652-406a34ff6cea",
"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-27T23:07:30.0502212+00:00"
},
"work_instruction_details_id": "23eb90e5-a8b9-470a-add0-49737201d46d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ed0d82f8-940e-49a0-95d0-855301028912",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "532427cc-180c-4ed6-9055-36ce7d9b1cac",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-27T23:07:30.0502212+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": "ad8d9a03-67f8-40b4-8002-1cb99d8d5606",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-27T23:07:30.0502212+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.