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": "1d25fdca-3fc0-4b87-9e5b-5ac28285580c",
"jobs_id": "6ab0c802-48df-449d-ad1a-2437aa9818b3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0802c806-c1b2-4b34-acde-7a771ee7a204",
"_parent_id": "c30647b0-c25b-46ef-9c25-7f7c0e06713e",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cdc90a76-e0fa-44d7-b423-a849abc47565",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f4bb64a6-bdf7-4e8a-a615-cafb8f5b9cf3",
"_parent_id": "54d844cd-c084-451c-a517-a0f3afd6c88c",
"root_parent_id": "16d2b608-23fd-442b-8d84-03b5adfd0b77",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "42d534fa-0b9d-498e-ad73-99f37169b2f3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bee2bccf-7efc-4a3b-aacb-e05227e5f463",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cffe3ee3-01ff-40c0-875a-9110432e358d",
"_parent_code": "sample string 6",
"sales_organization_id": "25dcb1ee-c0aa-416f-891e-483ab9f8f651",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"equipment_model_id": "743c867a-c563-4549-9799-be427860886a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6a726b6a-0156-403a-bd1f-30ecdc2c4b99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0f54a85d-68f0-47a8-8367-6e57b9dced1c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1cd178f8-205b-417d-9e38-6c10a59be16e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "84fb1db0-0eda-4511-93c9-70f58c504422",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"equipment_family_id": "5cd12543-d8e8-4ec6-aa2e-ecc6cd42c3d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bee2bccf-7efc-4a3b-aacb-e05227e5f463",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cffe3ee3-01ff-40c0-875a-9110432e358d",
"_parent_code": "sample string 6",
"sales_organization_id": "25dcb1ee-c0aa-416f-891e-483ab9f8f651",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"date_in_production_since": "2026-09-12T11:43:16.6262087+00:00",
"date_out_of_production_since": "2026-09-12T11:43:16.6262087+00:00",
"date_end_support": "2026-09-12T11:43:16.6262087+00:00",
"sales_organization_id": "06eadc57-3d84-4265-acf9-9c1e69f62130",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+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-12T11:43:16.6262087+00:00"
},
"project_status_id": "06c8c2a6-4a47-4e6a-a092-6b7e51c4803f",
"project_status_code": "sample string 10",
"project_status": {
"id": "bdae7f4d-53ec-4e49-84b8-405613482c52",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9b30aa84-2691-41f3-931f-d1aa95d6ab65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"company_id": "07b93134-d829-4795-81b6-fb2985a5d90a",
"company_code": "sample string 12",
"db_address_id": "1fd2b768-5f36-41b7-aec5-935f09cae0f2",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "186c97a2-a5ce-478c-ae5a-fbe4c644afd8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d15e2191-a236-42dd-8b43-84b3ca42f50e",
"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-12T11:43:16.6262087+00:00",
"date_create": "2026-09-12T11:43:16.6262087+00:00",
"date_update": "2026-09-12T11:43:16.6262087+00:00",
"updated_by_user_id": "22b414d5-6902-49db-a139-ed296885f11e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-12T11:43:16.6262087+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-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-12T11:43:16.6262087+00:00",
"date_last_job": "2026-09-12T11:43:16.6262087+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-12T11:43:16.6262087+00:00",
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00",
"is_mobile_installation": true
},
"job_type_id": "f2b11b28-cc04-4f7b-ad8e-1f874b171071",
"job_type_code": "sample string 7",
"job_type": {
"id": "87fb2f9d-647d-436a-8c3b-7d8b0f990c81",
"name": "sample string 2",
"sales_organization_id": "4c992a80-1b24-496d-9453-62d162a42ceb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00",
"code": "sample string 7"
},
"job_priority_id": "600bc60c-300e-48ff-ac14-32b52887441a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ec84a312-9a67-4eb6-b7d6-47238304213f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "3507e1da-2b50-47af-bbf5-a05a5fd04dbe",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"job_status_id": "de734dfc-aa18-4ffe-9aa5-3e9f50258e89",
"job_status_code": "sample string 11",
"db_address_id": "761cd623-3f0d-44fe-ac63-dd11832925a0",
"contact_id": "ff7b5eed-e9c3-4eca-b91e-ce6f34431418",
"requested_by_company_id": "f03ac076-bd02-4ab9-abde-4986e813bd0f",
"requested_by_contact_id": "b057139c-025f-45cc-88bd-50ad8b22e5d4",
"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-12T11:43:16.6262087+00:00",
"due_date": "2026-09-12T11:43:16.6262087+00:00",
"date_create": "2026-09-12T11:43:16.6262087+00:00",
"date_update": "2026-09-12T11:43:16.6262087+00:00",
"date_closed": "2026-09-12T11:43:16.6262087+00:00",
"suggested_user_id": "17d55500-40a3-408a-abee-6a596c07e0d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "163fc06a-a1eb-4bc7-a1f1-b6e12ccef802",
"db_language_id": "a3ddf65e-fc7c-4f7d-8931-d8204a3f05b8",
"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-12T11:43:16.6262087+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6c1fe9a6-d6a2-4eab-996c-0fe1546d15fa",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "159a5d17-af8e-4718-a545-37398cd24cc9",
"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": "8d09bf5a-2d0a-4230-bace-f11ea05f1682",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d7dad462-de7d-42ed-94a7-12cbe4acfcca"
},
"suggested_date_start": "2026-09-12T11:43:16.6262087+00:00",
"skill_id": "c4c37c21-fbe0-4c49-a3c9-e3734022bc08",
"skill_code": "sample string 32",
"skill": {
"id": "fa70b8f2-fe73-42db-a47d-ac279296073c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "56e4ab72-bf52-4550-a016-57ff3640110f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8205fefc-8c60-457c-bcbb-865d14e6bc96",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a908c452-a342-4cbd-9bb6-fdb7111b9826",
"db_currency_id": "5aae71c7-4171-4bc1-9be2-48aca746d318",
"db_language_id": "7f4a2116-1494-4f8d-ac92-5f68125c95b7",
"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-12T11:43:16.6262087+00:00"
},
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "35093ba3-6ec9-4a92-8199-7a769b32c789",
"date_reported_by_company": "2026-09-12T11:43:16.6262087+00:00",
"id2": 36,
"company_id": "a7dc9f37-ed8c-499e-b2d5-a053699d0252",
"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": "e5f7b4cf-57b3-40dc-8838-12476be625e5",
"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-12T11:43:16.6262087+00:00"
},
"work_instruction_details_id": "20363060-64a9-4f9f-8bf9-7fff28b9aeda",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e746a55e-d43f-437e-b752-758c8d6d400f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "71907f98-a473-47ea-8315-870a8e8dad25",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-12T11:43:16.6262087+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": "e2b79f13-1b76-4fd1-a956-a4690c393f0d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-12T11:43:16.6262087+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.