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": "b2c66424-6d05-4245-87d1-8a10601b2574",
"jobs_id": "be4dec1c-0377-4098-a941-e6d4ff6d1894",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "41d5c2fa-ba33-4efc-aa76-56702a172d2d",
"_parent_id": "9b68fd50-74bf-422c-9a4b-8559a754d2fc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "1ed7b88e-ba67-4c32-ba57-d7b8e427aba0",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1d398ed1-2aca-488e-920a-c3f6d51a6da2",
"_parent_id": "7bfd2295-df1a-4ba4-946a-59fdd4157e1f",
"root_parent_id": "f5da7ece-1fb1-440f-b08e-bfc41778ce62",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "3ce5bdeb-de8a-44f7-943f-ed980fe5f233",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3d863118-75cb-4269-bd60-e65f725defed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73495f0a-bbcd-49d0-8e43-3becff966071",
"_parent_code": "sample string 6",
"sales_organization_id": "9239ae3c-200d-43fe-900d-0bd3cfe18987",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"equipment_model_id": "c242d820-6aeb-4949-8bc5-9e3cfcc6a563",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "429db032-82a8-492b-a340-babb6f8fb766",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "bc354494-288e-4728-b70d-1821515124f9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0c007b5d-6126-4074-a41e-bc64303b383b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fac6fcff-4c5f-4845-84a4-81aa3337ec8c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"equipment_family_id": "a94190cc-1180-4dcf-912f-1c08cbe7b42a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3d863118-75cb-4269-bd60-e65f725defed",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "73495f0a-bbcd-49d0-8e43-3becff966071",
"_parent_code": "sample string 6",
"sales_organization_id": "9239ae3c-200d-43fe-900d-0bd3cfe18987",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"date_in_production_since": "2025-05-09T01:40:03.5109568+00:00",
"date_out_of_production_since": "2025-05-09T01:40:03.5109568+00:00",
"date_end_support": "2025-05-09T01:40:03.5109568+00:00",
"sales_organization_id": "30238707-4908-4935-85f5-d19e326c59db",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+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-05-09T01:40:03.5109568+00:00"
},
"project_status_id": "457d4734-5459-49b7-b63e-fdd12c57470f",
"project_status_code": "sample string 10",
"project_status": {
"id": "f301c92c-bcab-4912-bb5a-4f7a84f5be50",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b6f73bf0-fae4-413a-b21a-8f45b1489505",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"company_id": "51afd798-3310-4ca9-8259-3ae073d5efa0",
"company_code": "sample string 12",
"db_address_id": "38c34a8f-f602-4594-9492-f5683e2889b9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3d67081e-1fe4-4b90-9c38-5a7b734e194d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "972713e3-f32f-4033-9769-eefa75464f2a",
"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-05-09T01:40:03.5109568+00:00",
"date_create": "2025-05-09T01:40:03.5109568+00:00",
"date_update": "2025-05-09T01:40:03.5109568+00:00",
"updated_by_user_id": "aefa2c98-704d-42b4-9be9-5f0486d2f13c",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-09T01:40:03.5109568+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-05-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-09T01:40:03.5109568+00:00",
"date_last_job": "2025-05-09T01:40:03.5109568+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-09T01:40:03.5109568+00:00",
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00",
"is_mobile_installation": true
},
"job_type_id": "eea80b45-22c1-465e-ad81-dbc3b44051bc",
"job_type_code": "sample string 7",
"job_type": {
"id": "c4499f43-68aa-4eb2-897b-e22f9f689df6",
"name": "sample string 2",
"sales_organization_id": "5d1f4a26-df44-4787-b83c-1f1535a6c317",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00",
"code": "sample string 7"
},
"job_priority_id": "5260a67d-202f-412e-a88d-cc5eaf5967c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "dc3c0dd7-c670-45eb-9623-030465816e40",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "74b4a6bd-42d0-4225-a70a-2cb5c012d634",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"job_status_id": "00939335-3416-4da9-8632-4304bc7bb7d7",
"job_status_code": "sample string 11",
"db_address_id": "393e33e0-a38c-41c7-9ff5-3b2c378479a4",
"contact_id": "9b369a32-c566-47fa-b3e7-b19c6a89aaa1",
"requested_by_company_id": "9d5104ef-aedc-47fb-bfdf-1873395d74d0",
"requested_by_contact_id": "6edc2c62-5f3d-4fe5-8b78-4c45676622db",
"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-05-09T01:40:03.5109568+00:00",
"due_date": "2025-05-09T01:40:03.5109568+00:00",
"date_create": "2025-05-09T01:40:03.5109568+00:00",
"date_update": "2025-05-09T01:40:03.5109568+00:00",
"date_closed": "2025-05-09T01:40:03.5109568+00:00",
"suggested_user_id": "bd0bd61f-7f00-4a78-887c-001d95d9752f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cbe46d24-bd87-40ae-baac-8f9b3d5489ab",
"db_language_id": "f5f296d0-e7c3-4825-8ba7-c4d0d7dd1bf5",
"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-05-09T01:40:03.5109568+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "68f88bb6-0cc8-41a0-b3c2-3cb54100995b",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "556ebf60-2103-4220-9239-1af81fd4601c",
"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": "0699103e-b170-4aa3-a0bb-9ee8de16d597",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5ce4014f-5e40-48eb-b39d-75178d6f9b9b"
},
"suggested_date_start": "2025-05-09T01:40:03.5109568+00:00",
"skill_id": "bcc2d937-5da3-4aa5-9dcd-ac75d5aeb947",
"skill_code": "sample string 32",
"skill": {
"id": "afe27ccc-d2a7-45b6-b448-c39cc3326e9b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a0ffb9dc-c62b-4a72-8d8a-da65601a5e95",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "aee5aebc-4f2b-44b6-bb0c-59543a7077bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "483e5880-b9a9-4314-839c-35bf307964d7",
"db_currency_id": "7e5fe257-b120-4a19-b3ee-2184098e4001",
"db_language_id": "e4c07705-3c4a-41d3-bf20-38394220369f",
"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-05-09T01:40:03.5109568+00:00"
},
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "296632cb-0ff1-4269-a2aa-ded6cf56bc15",
"date_reported_by_company": "2025-05-09T01:40:03.5109568+00:00",
"id2": 36,
"company_id": "57a95ad6-130c-433f-b8f2-02b5730c507d",
"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": "903f67a2-c35c-40b2-9638-8be1a82b0eb8",
"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-05-09T01:40:03.5109568+00:00"
},
"work_instruction_details_id": "d395db65-2070-48c2-9e81-de5c3f5e48b5",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "cdd46826-6be7-4b44-bf16-3b6c6da96009",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "005a92d6-3b60-4f8e-9e22-fda88e33e7b9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-09T01:40:03.5109568+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": "0efaeda2-0be9-42e1-aff5-2423057b33a2",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-09T01:40:03.5109568+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.