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": "75b4dd65-4cba-41a2-8eab-75f1b3038356",
"jobs_id": "8abb52f9-596f-4086-907f-45fd7a9fb8e7",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0fc78361-1883-41e9-92b6-80e34b56ae04",
"_parent_id": "7fbe0393-4e4d-4f3a-b680-c2a6934a14e7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79029bfb-bb42-4dde-a48d-4ba1451aa0ac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "2a63741c-7ee4-473f-8ace-afcb48d08c5f",
"_parent_id": "d757e019-bd59-4a2a-8180-f808585fbcdf",
"root_parent_id": "79fd137d-2029-46a6-8f7e-79a5184b2cea",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e4d3c482-0c56-4f48-b904-5cfd2d202b8a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2cac772e-245c-403e-b892-6744ceb5defe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d87bbbd-822b-47c0-a192-72c29de31fee",
"_parent_code": "sample string 6",
"sales_organization_id": "d41f35b3-a4a9-4d2b-81aa-2e3f06eb8454",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"modified_dateutc": "2025-12-05T11:00:19.6249998+00:00"
},
"equipment_model_id": "764eee2e-bb1a-4d4e-9afa-839b314d22a5",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3162a75b-8804-49d0-8b37-45f7b6abe7fb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "264a8c5c-8980-4aed-948c-6a6eee205c02",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1dba17ea-49fd-44fd-81c0-d5f1db99bbcb",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "46439f05-a944-4c22-95c8-d7a5df7181d5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"modified_dateutc": "2025-12-05T11:00:19.6249998+00:00"
},
"equipment_family_id": "a6902f95-c33e-4065-a4bd-f4bab274ed0a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2cac772e-245c-403e-b892-6744ceb5defe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7d87bbbd-822b-47c0-a192-72c29de31fee",
"_parent_code": "sample string 6",
"sales_organization_id": "d41f35b3-a4a9-4d2b-81aa-2e3f06eb8454",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"modified_dateutc": "2025-12-05T11:00:19.6249998+00:00"
},
"date_in_production_since": "2025-12-05T11:00:19.6249998+00:00",
"date_out_of_production_since": "2025-12-05T11:00:19.6406255+00:00",
"date_end_support": "2025-12-05T11:00:19.6406255+00:00",
"sales_organization_id": "137b1a62-9b97-41e7-942f-9beb1c4c4418",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+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-12-05T11:00:19.6406255+00:00"
},
"project_status_id": "4702fde6-8410-4fa5-a415-cdead69fee6d",
"project_status_code": "sample string 10",
"project_status": {
"id": "e5ba259f-f682-40a1-bc08-8d0fd738c4a5",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "22bb58ef-7d28-4867-bc84-b524aec2beaf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00"
},
"company_id": "3ed04aec-2ede-4bb6-b5b4-be156d7d0465",
"company_code": "sample string 12",
"db_address_id": "b9374e6c-c854-4264-be21-3c7ade44f410",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "02a92ed9-ae78-4991-9b0e-3e747f64d67a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6ee2d67f-2fcd-4c9d-b644-98ca14dccbc2",
"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-12-05T11:00:19.6406255+00:00",
"date_create": "2025-12-05T11:00:19.6406255+00:00",
"date_update": "2025-12-05T11:00:19.6406255+00:00",
"updated_by_user_id": "72a8d861-848b-4a99-adf4-e33fc71dd749",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-05T11:00:19.6406255+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-12-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-05T11:00:19.6406255+00:00",
"date_last_job": "2025-12-05T11:00:19.6406255+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-05T11:00:19.6406255+00:00",
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00",
"is_mobile_installation": true
},
"job_type_id": "03fdc445-6f4e-439e-9867-7eca9152434f",
"job_type_code": "sample string 7",
"job_type": {
"id": "78ca7396-7e68-4b6b-b529-a6294a1cb835",
"name": "sample string 2",
"sales_organization_id": "4a57668a-efec-4059-ad85-ce33ca027c0c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00",
"code": "sample string 7"
},
"job_priority_id": "4ec744eb-ecf1-4369-9a10-764ff99bdddb",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "516218cf-c7fc-4bfe-a496-ddcef4713530",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fac39a11-33d8-4f12-b1dd-a767687721d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00"
},
"job_status_id": "66d6ea5b-7582-468c-a985-54f7592a88c9",
"job_status_code": "sample string 11",
"db_address_id": "a2b163b4-58d7-41a7-ad43-db69f573f85a",
"contact_id": "0429ab19-ff92-48f2-9812-4361b477c345",
"requested_by_company_id": "a0a6ee4b-b666-4d84-90ef-78288fea9e01",
"requested_by_contact_id": "789e98c2-a5a5-4cb6-8089-f56e50330925",
"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-12-05T11:00:19.6406255+00:00",
"due_date": "2025-12-05T11:00:19.6406255+00:00",
"date_create": "2025-12-05T11:00:19.6406255+00:00",
"date_update": "2025-12-05T11:00:19.6406255+00:00",
"date_closed": "2025-12-05T11:00:19.6406255+00:00",
"suggested_user_id": "79a64d8b-4d53-4152-8a72-0c08cdfbd9de",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "abc95311-5929-4663-bdb8-507f64fda28d",
"db_language_id": "0a02af90-7223-4217-89ba-7c3e4904811a",
"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-12-05T11:00:19.6406255+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c0e4827f-87e5-4a9f-b5cf-a0850f7915cd",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9eb35093-5738-4b7a-968b-9f4971e49b70",
"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": "a81a6f70-6704-4998-8964-4f100e47784a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dd234eca-f79f-49c3-9c0b-f4b167753706"
},
"suggested_date_start": "2025-12-05T11:00:19.6406255+00:00",
"skill_id": "cfb0aece-b4dd-46a1-8d54-8755459576d3",
"skill_code": "sample string 32",
"skill": {
"id": "7c9cf8cf-9678-4afa-abe9-f763ab155955",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8a4e1792-25df-416d-b365-99a283bb2fbf",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a25a4699-0924-4c8f-9062-4f18fec5da00",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6065d172-fbca-4f18-88ea-ec0289641afa",
"db_currency_id": "008ef39a-5805-48bb-9e89-4b35388ab658",
"db_language_id": "f7d2f267-e887-4627-85ac-15a05967dcc2",
"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-12-05T11:00:19.6249998+00:00"
},
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "43c768e6-195a-45ff-ad0b-396000f8599e",
"date_reported_by_company": "2025-12-05T11:00:19.6406255+00:00",
"id2": 36,
"company_id": "573bc750-c388-4501-89be-6805afae6b31",
"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": "ad7e6052-6b61-4535-95f4-e527767e0bf2",
"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-12-05T11:00:19.6406255+00:00"
},
"work_instruction_details_id": "b714eae1-fbc0-4043-9995-e03b73c23916",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "27172e90-095c-4e1f-8e4d-2b458e92f811",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6bcd465e-1c9c-45e2-8df8-3fede3cedd2c",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-05T11:00:19.6406255+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": "762a6fc7-9833-402f-b4a6-40bec4f066c1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-05T11:00:19.6406255+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.