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": "63e44af0-b50d-4d34-ad20-cc5d70aeb56e",
"jobs_id": "ea9e12c7-95a7-4237-8f43-0581bc64bfc4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ed773ef8-7ec6-4bc2-98d1-8838f86d3f41",
"_parent_id": "358d8ace-5994-4748-8dcb-345e68ebd967",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2b257571-b060-4d41-ae29-abc3a5b1ca25",
"project_reference_back_office": "sample string 5",
"project": {
"id": "80b08a2a-ff71-422d-85f9-a73420ef19af",
"_parent_id": "2078f9e8-a4c6-49dd-9873-94059b916c09",
"root_parent_id": "3fb7e986-7c1c-46f1-902b-c92c1237bb05",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9f7220a9-28ad-4a16-a807-e812166c3d9a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7a5b3381-a9af-485a-915a-7a721b268916",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dbef1a11-3e25-4f3a-a4f6-09cc247e2226",
"_parent_code": "sample string 6",
"sales_organization_id": "8445168e-73c9-4e7a-873d-5f0f2be9e72b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"equipment_model_id": "cc24362b-7997-408c-bc6e-b2af39892e14",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c1dda4f2-28f4-4fb0-a1bb-c2a9efcdd1c7",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f0f0f5e7-3033-4fb2-b5d2-e9345e167dda",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "920713db-832f-4de4-a0b0-d2080e66f1b9",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "322fbd29-0e3d-4c8c-a894-d428ad0d4e20",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"equipment_family_id": "c088b62f-944b-4574-b531-499daad0f95b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7a5b3381-a9af-485a-915a-7a721b268916",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "dbef1a11-3e25-4f3a-a4f6-09cc247e2226",
"_parent_code": "sample string 6",
"sales_organization_id": "8445168e-73c9-4e7a-873d-5f0f2be9e72b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"date_in_production_since": "2026-07-12T07:14:50.6462807+00:00",
"date_out_of_production_since": "2026-07-12T07:14:50.6462807+00:00",
"date_end_support": "2026-07-12T07:14:50.6462807+00:00",
"sales_organization_id": "e14ad050-11ae-4297-aaa6-950ec469ce40",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+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-07-12T07:14:50.6462807+00:00"
},
"project_status_id": "b5341061-5d3f-4631-a3d2-b18e9c3f30dc",
"project_status_code": "sample string 10",
"project_status": {
"id": "6ebbabc0-701f-4b5f-ba4e-92a33fe854a9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c2c4870d-cc97-4de8-b2ed-39ab31ac3d04",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"company_id": "4060f95d-d0f6-41e3-ad80-b0df46322f82",
"company_code": "sample string 12",
"db_address_id": "2d64c91c-54a0-4317-9ea5-2997db472b36",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0f723168-8d69-4adf-bb1c-006cee4ddc51",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8d1acde5-a1d8-44aa-9dcc-0c366456c6d1",
"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-07-12T07:14:50.6462807+00:00",
"date_create": "2026-07-12T07:14:50.6462807+00:00",
"date_update": "2026-07-12T07:14:50.6462807+00:00",
"updated_by_user_id": "4d8f5b45-7aad-481c-8e76-4b2035bdae35",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-12T07:14:50.6462807+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-07-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-12T07:14:50.6462807+00:00",
"date_last_job": "2026-07-12T07:14:50.6462807+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-12T07:14:50.6462807+00:00",
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00",
"is_mobile_installation": true
},
"job_type_id": "2641c3a0-f15c-4d4f-9c65-3603567fda9a",
"job_type_code": "sample string 7",
"job_type": {
"id": "0fd4d8d2-18b7-49ba-b362-7e274a0f2aab",
"name": "sample string 2",
"sales_organization_id": "9dbdbb6a-47ee-4bf8-8590-f710507f635f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00",
"code": "sample string 7"
},
"job_priority_id": "4775d71e-61c1-4b12-bafe-944963a78a5e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ba5cbe7c-997b-40e5-b75c-a2504a466dd6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "10d823dc-32ed-4af5-8ea7-682637e891d9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"job_status_id": "31de4893-e562-4b92-896a-220c3df9c67b",
"job_status_code": "sample string 11",
"db_address_id": "e15f6166-1657-47ed-8091-b315045594b9",
"contact_id": "05b30fa9-8ac3-4921-8b8c-7f929bbd023f",
"requested_by_company_id": "1821f143-72fd-49c9-ab33-4e36794d54a0",
"requested_by_contact_id": "afadd0ef-7a51-4e9b-8fd8-eeae12a94f88",
"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-07-12T07:14:50.6462807+00:00",
"due_date": "2026-07-12T07:14:50.6462807+00:00",
"date_create": "2026-07-12T07:14:50.6462807+00:00",
"date_update": "2026-07-12T07:14:50.6462807+00:00",
"date_closed": "2026-07-12T07:14:50.6462807+00:00",
"suggested_user_id": "067424c1-1f19-4ef0-b193-c977f47bb639",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "dccade8c-0968-4838-b8aa-7a2903a37018",
"db_language_id": "18ff0f83-7b93-46af-a0bf-90c32047491c",
"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-07-12T07:14:50.6462807+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e5a9cdfb-ceaa-48c1-a5a0-95d64663e9c3",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c3f8a0b7-bf71-4e48-9e87-2e2c18e24e45",
"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": "f2e15da7-b2f7-46ec-8f3f-94e7dc5ba5a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cceabfa0-8356-48cb-a79c-e68b08ebaef5"
},
"suggested_date_start": "2026-07-12T07:14:50.6462807+00:00",
"skill_id": "c4352ba7-4506-429b-a512-bfb584f43eb6",
"skill_code": "sample string 32",
"skill": {
"id": "9dc5156c-c5fe-4bc7-858d-ff2fb561eb33",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "299bb51c-8180-453d-842a-e0dd71297a17",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f62bab2-6f50-40d9-8a40-6085db2b2751",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8efd792a-6de0-4dad-a821-aff192d6288d",
"db_currency_id": "4640cebd-9366-4311-8533-e11662d90fa6",
"db_language_id": "e16f450f-af84-4354-a3cf-848f11dcea4a",
"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-07-12T07:14:50.6462807+00:00"
},
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1850a823-847d-49e2-8693-f30b5509ebb8",
"date_reported_by_company": "2026-07-12T07:14:50.6462807+00:00",
"id2": 36,
"company_id": "2ec45896-6f47-4976-bd55-53dcefbdac05",
"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": "035aa501-6b70-49fd-af5f-f083029befb1",
"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-07-12T07:14:50.6462807+00:00"
},
"work_instruction_details_id": "e712cefa-68ef-4fc9-bfff-bb95dbd01712",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8187219d-6043-44e7-8218-1ebcd638e048",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2179471c-1f25-4268-961d-be573663dc03",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-12T07:14:50.6462807+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": "89b9418b-20b8-4770-8f63-9f1d84fc947d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-12T07:14:50.6462807+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.