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": "1c73a2e5-3f92-4c9c-9c91-4bad1130d6ca",
"jobs_id": "33d6c788-7480-4e22-a733-29b31f389fbb",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ab189574-a94f-4153-b7c9-4123946ca164",
"_parent_id": "f1c732f1-08b0-4d03-8fad-dcde41093ead",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c42e8ab0-284f-4c34-ac4f-fbdca0eabf7d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f2d3e987-91ff-48ad-ba1b-4c3eed6f074e",
"_parent_id": "ed6fbbbb-e7a2-41a3-97bb-9be8cdde95bd",
"root_parent_id": "921b3c07-11b1-4200-b74c-1ffbe7647889",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "039bd6a2-e9b9-49ec-90bc-e96ff39eac96",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "0cfb3078-0df9-45cc-8226-7de6514986a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac33537-a4f5-47c0-adb5-117a7aa7b443",
"_parent_code": "sample string 6",
"sales_organization_id": "4294aa10-dca3-44f8-8d56-f8b10fa2a5c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"equipment_model_id": "beb10299-7983-40b0-b907-88110f205237",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "8f917fde-7255-47b3-b00a-92d801c03385",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "84e38693-40b8-4d61-8a28-154815bf4ee7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "552831a0-9a8c-4d89-b9d4-fcc886ea2cd2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3a06097f-af96-4f66-8785-3f6b5e56e6be",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"equipment_family_id": "901139b3-7d12-4199-9fc8-049b964299d0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "0cfb3078-0df9-45cc-8226-7de6514986a8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cac33537-a4f5-47c0-adb5-117a7aa7b443",
"_parent_code": "sample string 6",
"sales_organization_id": "4294aa10-dca3-44f8-8d56-f8b10fa2a5c7",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"date_in_production_since": "2026-09-05T22:35:58.2695922+00:00",
"date_out_of_production_since": "2026-09-05T22:35:58.2695922+00:00",
"date_end_support": "2026-09-05T22:35:58.2695922+00:00",
"sales_organization_id": "7a6657da-d84a-4e20-8d80-d4c057e3b2c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+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-05T22:35:58.2695922+00:00"
},
"project_status_id": "ca1beb88-73fc-4b98-a439-60804a52084d",
"project_status_code": "sample string 10",
"project_status": {
"id": "9e1a422e-6684-403d-9a77-1f2235ab9da0",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8ea48016-c083-4dbd-a9fd-2a0b234a0e75",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"company_id": "c37d55bd-ce35-4d2d-a776-d6bf647bce24",
"company_code": "sample string 12",
"db_address_id": "fe345461-f979-4b53-b0b0-ce15645a06c5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f451a8b7-f984-4455-bcb8-edc0c139d437",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6fe7b403-3f8f-4a1f-bfa9-e3788c2cdaf8",
"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-05T22:35:58.2695922+00:00",
"date_create": "2026-09-05T22:35:58.2695922+00:00",
"date_update": "2026-09-05T22:35:58.2695922+00:00",
"updated_by_user_id": "1268e751-fc70-4cef-a323-985205a9ea04",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-05T22:35:58.2695922+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-05T22:35:58.2695922+00:00",
"date_last_job": "2026-09-05T22:35:58.2695922+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-05T22:35:58.2695922+00:00",
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00",
"is_mobile_installation": true
},
"job_type_id": "a7052f60-746b-4ab5-88ac-c450fa9c4bf8",
"job_type_code": "sample string 7",
"job_type": {
"id": "8b1a2cda-d939-4d9f-9eb5-7e11d2eb4cc2",
"name": "sample string 2",
"sales_organization_id": "621db752-54f9-4e8d-8d34-60afda12ed3a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00",
"code": "sample string 7"
},
"job_priority_id": "37364861-0135-4f12-9ee3-94bebcf1ecf3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "08db4706-73b1-4cb3-8f08-3ef3a708ebd8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b75c88b3-42cf-42ac-b119-91b46ae46800",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"job_status_id": "f8fb5c52-e9e3-49b3-9dd5-fe91c0ff9ab8",
"job_status_code": "sample string 11",
"db_address_id": "918a5e41-fa5e-41b4-b960-a7309a34f6b2",
"contact_id": "2604fe28-f693-44d5-8253-353925538296",
"requested_by_company_id": "ea187873-a20a-4b94-a735-c86915dca7f3",
"requested_by_contact_id": "4ef18bca-b14e-4022-bf2c-9c902b3ac80b",
"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-05T22:35:58.2695922+00:00",
"due_date": "2026-09-05T22:35:58.2695922+00:00",
"date_create": "2026-09-05T22:35:58.2695922+00:00",
"date_update": "2026-09-05T22:35:58.2695922+00:00",
"date_closed": "2026-09-05T22:35:58.2695922+00:00",
"suggested_user_id": "12561f0a-80e2-460a-9fe8-bc5c1a958291",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "29e051eb-dade-4248-a279-8554f3d020d9",
"db_language_id": "a0fa0ea2-1b38-4281-af2f-85cfc6b8ed0c",
"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-05T22:35:58.2695922+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "970269c9-56d5-457c-a217-879658d46723",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "956d66d1-6064-4005-810d-9bfd890c0b35",
"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": "c7b602cb-4879-4a07-b553-e426c70ee14d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "47a71c14-057e-4e80-825d-7c4c1525b943"
},
"suggested_date_start": "2026-09-05T22:35:58.2695922+00:00",
"skill_id": "3ab2dc20-e178-47ba-83b6-bcf465ffff89",
"skill_code": "sample string 32",
"skill": {
"id": "2046cc36-0c0c-49d1-a8ae-4aa3ad5ecfbf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5aafc7bc-8671-4b3a-9854-f7053a0fce81",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e38dcb52-d43e-4e30-8e63-996c1f2df7f5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "318f4b61-c243-44c5-9872-702599acc15c",
"db_currency_id": "1d34d053-2966-4a6a-90a2-c5a8f6398785",
"db_language_id": "70d9e9f7-36f9-4193-bd12-81557b2d6ed6",
"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-05T22:35:58.2695922+00:00"
},
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0cbdeea2-ebdd-47d1-911d-3dcc1d5d852f",
"date_reported_by_company": "2026-09-05T22:35:58.2695922+00:00",
"id2": 36,
"company_id": "9405d880-5851-4e0b-84b0-99927ad1c0d7",
"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": "b0cfebc7-7c28-40f0-9cf3-cdcad50116c3",
"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-05T22:35:58.2695922+00:00"
},
"work_instruction_details_id": "14b64845-0f1f-48a5-9d11-1a2409578b36",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9c5ab160-cf8c-4431-bbb6-ced44d54398f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "03fd9dc2-b8c6-4a95-88df-5b1ca6ed98f7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-05T22:35:58.2695922+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": "cd057ee2-05cd-4580-ae8a-c388e7958421",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-05T22:35:58.2695922+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.