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": "27fa986b-e210-4d02-9475-cd07be36d63e",
"jobs_id": "402ad582-111c-4866-b76f-ebd449591570",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2526440d-6bb3-46fc-a7d8-9e1c45e1de32",
"_parent_id": "771c7042-c690-43ae-9ee7-41783796627f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e626ad4a-38fe-4330-9e73-c685e3527ace",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9fb43ee0-3d12-4c01-a636-f92d1512fe0f",
"_parent_id": "dc15d011-9a77-480a-bad1-c5e2e3d15d00",
"root_parent_id": "0ea97d14-f9da-411a-97c3-03c2fc631831",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "605d683c-f113-4fd4-8c72-ff7a4b08760b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "bbde0354-c938-433a-a0ba-e453c886902b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17b15312-1361-44fc-9b17-58201b42ce24",
"_parent_code": "sample string 6",
"sales_organization_id": "bc490a90-6a6e-46af-a0a0-0fdf615da416",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"equipment_model_id": "3166fa9e-a85f-4d91-b436-dca06bf22d42",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "af900213-21f2-4365-8adb-cf8d7921455b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d7e0018c-1979-4f23-9477-e5a7d527c61f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a68f7faf-141a-47e5-948e-63091634bbb3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "73884a48-b530-4b8a-8242-83d6df6aff96",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"equipment_family_id": "99644e38-70fe-4427-bd62-2de79df09106",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "bbde0354-c938-433a-a0ba-e453c886902b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "17b15312-1361-44fc-9b17-58201b42ce24",
"_parent_code": "sample string 6",
"sales_organization_id": "bc490a90-6a6e-46af-a0a0-0fdf615da416",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"date_in_production_since": "2024-12-21T16:45:57.2223866+00:00",
"date_out_of_production_since": "2024-12-21T16:45:57.2223866+00:00",
"date_end_support": "2024-12-21T16:45:57.2223866+00:00",
"sales_organization_id": "9c07c63c-95df-49ba-abc3-180a2b78a4ed",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+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": "2024-12-21T16:45:57.2223866+00:00"
},
"project_status_id": "5f11f5c8-3cb5-4acf-b055-2b36beec36a0",
"project_status_code": "sample string 10",
"project_status": {
"id": "0c520e95-76c4-4ed9-bb08-9728fffc7014",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "06472160-b837-4ab8-a73b-6565c4700a3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"company_id": "b8d43915-5b1f-473f-9ca1-bfdf82102d54",
"company_code": "sample string 12",
"db_address_id": "eb061ab0-b176-4502-ade1-545c0c1cd7aa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "d75fded2-ff83-4889-ba75-2b9b0bae72ba",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4a5788b5-df31-4c7d-b197-cb47227229ba",
"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": "2024-12-21T16:45:57.2223866+00:00",
"date_create": "2024-12-21T16:45:57.2223866+00:00",
"date_update": "2024-12-21T16:45:57.2223866+00:00",
"updated_by_user_id": "e6c5861d-e0b9-4e5f-844a-ba42257ccfb1",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-12-21T16:45:57.2223866+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": "2024-12-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-12-21T16:45:57.2223866+00:00",
"date_last_job": "2024-12-21T16:45:57.2223866+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-12-21T16:45:57.2223866+00:00",
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00",
"is_mobile_installation": true
},
"job_type_id": "2a68967a-a0a4-4080-a24a-1cc420846724",
"job_type_code": "sample string 7",
"job_type": {
"id": "edf59fe6-6049-4f05-b73b-5889a95d3391",
"name": "sample string 2",
"sales_organization_id": "878bf7a9-3a75-49a2-b4d2-de4cf7b1c721",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00",
"code": "sample string 7"
},
"job_priority_id": "f50fcd33-7e70-4ae8-9552-f0a786aeb976",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "7e8b38dc-e5e0-4907-863b-ea6674d68ff9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8f0e3227-56ea-4c5e-a43c-230fbe106475",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"job_status_id": "c9ce1547-7410-453d-a5bb-9447a6631e65",
"job_status_code": "sample string 11",
"db_address_id": "471eed45-746b-4b65-8595-e81b0663ea23",
"contact_id": "acdcb1ca-e079-42d1-8245-fb4eb804ae5b",
"requested_by_company_id": "d618da1e-779a-4de2-b067-1350a2002f72",
"requested_by_contact_id": "8b5d6bc0-345a-43ec-8e41-1589886cd25c",
"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": "2024-12-21T16:45:57.2223866+00:00",
"due_date": "2024-12-21T16:45:57.2223866+00:00",
"date_create": "2024-12-21T16:45:57.2223866+00:00",
"date_update": "2024-12-21T16:45:57.2223866+00:00",
"date_closed": "2024-12-21T16:45:57.2223866+00:00",
"suggested_user_id": "7d59ee24-25f3-42b8-bdb2-84d74c773364",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3629f026-8ff0-43f7-ad18-48c227ab8316",
"db_language_id": "385b1f9d-29da-49f1-a867-822589c0458b",
"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": "2024-12-21T16:45:57.2223866+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e9e003b-4eb5-4aec-ac46-7c3360f9eb95",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c2c02894-0c54-472c-b3d4-6c3f7201d5da",
"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": "e3ae808a-b7a8-455a-956a-07abf65b9547",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3dcd018c-81f2-40d7-a5b0-28c7da71d38f"
},
"suggested_date_start": "2024-12-21T16:45:57.2223866+00:00",
"skill_id": "3684a242-1763-4ba7-a047-84bf9a80d274",
"skill_code": "sample string 32",
"skill": {
"id": "3880fd0c-0568-4097-8013-54767cbd9588",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b23d7daf-2efa-4d12-9b08-dcbb65eb2fa1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1cc10d5d-01ff-4153-bfaa-176ec4fe049c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "81db9ad4-5c29-45fb-9b36-5cfb1d93f138",
"db_currency_id": "a29b53f1-4bad-459b-adee-fe5b722ed642",
"db_language_id": "58157e34-e25f-4146-bd2b-f975cfd24024",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "825e50ca-f75a-43fb-a38a-d8c5cf13d9b1",
"date_reported_by_company": "2024-12-21T16:45:57.2223866+00:00",
"id2": 36,
"company_id": "427b4337-a24b-44c7-b4d4-3242193561a0",
"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": "4a349d84-5c6b-4018-8ac0-9c88474eb2bb",
"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": "2024-12-21T16:45:57.2223866+00:00"
},
"work_instruction_details_id": "ed4592df-8e97-498f-985d-a700a030f6e1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f268985a-b4ad-4495-925e-865ff8a97b13",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "481f06b2-ca24-4bf0-9d3d-b75dd4b35fa7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-12-21T16:45:57.2223866+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": "28f469e8-d480-4f83-8843-a90f3290dc0a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-12-21T16:45:57.2223866+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.