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": "26bba520-d3ae-4e64-8b3d-7ae0319d336a",
"jobs_id": "3b6a2548-ad36-492d-8712-95ecc2006966",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4f31f03c-5725-4f58-a7cb-582add358225",
"_parent_id": "136172e9-c5d1-452c-8eb4-2adc65e02d34",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "91cd048e-d4c1-4156-baff-0d9638261f43",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f40812b7-1b2b-4d18-be62-99a8ac152114",
"_parent_id": "9108837a-42ba-4f7e-811d-dcd1722604a4",
"root_parent_id": "0e20f571-79e5-46ea-81a9-395dc7218db9",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fd576d43-12c4-453f-a69c-2c9041d4c3a8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "babe839e-a96c-4afe-aeba-d36b9705cda5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9fc5a4d8-2fbb-4772-b067-5ae1c37f5d78",
"_parent_code": "sample string 6",
"sales_organization_id": "5f918486-4934-47d9-98fe-a7a64c3811a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"equipment_model_id": "67c98f29-2480-4b9c-8db7-a4bc50edc2c7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "eef33f79-2b5c-49ed-89f0-be11962f2df2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8edfb889-d959-45d5-97c3-bdcd65343fe9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1d6c9252-55ff-4402-ba8a-3ee1f7d8b95a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "0af58fd5-d8a1-48e4-ae4c-e659488abc0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"equipment_family_id": "4a920a15-9447-477f-a79a-f05d83ed7e59",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "babe839e-a96c-4afe-aeba-d36b9705cda5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9fc5a4d8-2fbb-4772-b067-5ae1c37f5d78",
"_parent_code": "sample string 6",
"sales_organization_id": "5f918486-4934-47d9-98fe-a7a64c3811a3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"date_in_production_since": "2025-06-05T18:52:05.3430762+00:00",
"date_out_of_production_since": "2025-06-05T18:52:05.3430762+00:00",
"date_end_support": "2025-06-05T18:52:05.3430762+00:00",
"sales_organization_id": "50230b2c-8f42-44fb-88e6-38c1558a7848",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+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-06-05T18:52:05.3430762+00:00"
},
"project_status_id": "b74f95d1-ef63-4a4a-a2b1-22eab68c3b4b",
"project_status_code": "sample string 10",
"project_status": {
"id": "c029b358-7575-433c-8935-8fb415f8904c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "97d00b06-9025-4544-8983-afb2bdb418ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"company_id": "a31e557b-d5bf-4e71-b27f-e19edd128521",
"company_code": "sample string 12",
"db_address_id": "2c3ae86e-1827-4918-a429-751cfcd63241",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "23258d21-e2be-4c42-97e5-f56cb180b937",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "aa70f4ca-f861-453a-821f-14a2170f0867",
"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-06-05T18:52:05.3430762+00:00",
"date_create": "2025-06-05T18:52:05.3430762+00:00",
"date_update": "2025-06-05T18:52:05.3430762+00:00",
"updated_by_user_id": "8f4438fc-7978-42c4-9bdc-25cc16ad7632",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-05T18:52:05.3430762+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-06-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-05T18:52:05.3430762+00:00",
"date_last_job": "2025-06-05T18:52:05.3430762+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-05T18:52:05.3430762+00:00",
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00",
"is_mobile_installation": true
},
"job_type_id": "3374692f-5700-4b1d-a9ec-85425ebd156a",
"job_type_code": "sample string 7",
"job_type": {
"id": "e72c098b-dc6d-471c-874d-df491bd6bca1",
"name": "sample string 2",
"sales_organization_id": "ef53df1d-272d-461a-bb98-85d96f01abfa",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00",
"code": "sample string 7"
},
"job_priority_id": "85af93da-c5d6-44fb-a80c-4c453cc186b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "61ac1373-1d18-4b1a-8015-04fc6908c78f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "1cc3c3ba-0e03-40ea-b6e7-6f39265b4bba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"job_status_id": "5ee91efc-fec7-447f-befd-0d7bdbff5f3a",
"job_status_code": "sample string 11",
"db_address_id": "91fe535d-5ffe-4024-a235-7b381cc93520",
"contact_id": "591dee75-f24d-4ca4-8a07-ee373eb51d3a",
"requested_by_company_id": "1a29f691-e102-4285-b770-57665bf9d4d4",
"requested_by_contact_id": "33fadd37-fe69-419f-9361-fcb2fdca7353",
"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-06-05T18:52:05.3430762+00:00",
"due_date": "2025-06-05T18:52:05.3430762+00:00",
"date_create": "2025-06-05T18:52:05.3430762+00:00",
"date_update": "2025-06-05T18:52:05.3430762+00:00",
"date_closed": "2025-06-05T18:52:05.3430762+00:00",
"suggested_user_id": "7caca950-ad12-4708-aac9-e2a15969dc2d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "507ed892-5192-436c-8710-1d3bf7383169",
"db_language_id": "21c57d5c-b52d-46ca-a3ea-6c2c94a60a8c",
"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-06-05T18:52:05.3430762+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6560e8e6-7978-4d8f-a483-9378e11ed6ea",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f0e701b0-501c-44e4-bf67-76a79566426c",
"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": "ada6058e-ed76-403f-bd2d-3ab1abb134f5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ec532496-e54e-42ba-8fe0-f02d07bd7f39"
},
"suggested_date_start": "2025-06-05T18:52:05.3430762+00:00",
"skill_id": "43c0d8fa-90f8-4b6c-90e5-8cad18e96ad3",
"skill_code": "sample string 32",
"skill": {
"id": "ad3ce170-29ee-4c4f-a5fb-970586bd3c38",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "202172e8-1ef1-4988-bf9d-c1abf2d633ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "63182098-937a-48d0-944b-7713a98391fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9f4ff6b0-68de-47c2-868b-08e0dafcdbcc",
"db_currency_id": "13dc28af-5633-4d8a-86ac-ce48229ddcbc",
"db_language_id": "9d42f591-2806-4a1d-a941-d83a2ee7265b",
"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-06-05T18:52:05.3430762+00:00"
},
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "56ccb5ed-c00b-486b-9cc5-683fe7d3a2f4",
"date_reported_by_company": "2025-06-05T18:52:05.3430762+00:00",
"id2": 36,
"company_id": "1c1d4111-f795-478f-8460-75858721865b",
"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": "9c3188f0-fe1f-4bbb-825f-efa301b3e870",
"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-06-05T18:52:05.3430762+00:00"
},
"work_instruction_details_id": "62853574-b6ff-4416-b9a8-65e0f86fff22",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "eca6e37d-8090-47ad-8a87-a23def79b44e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ecd646ab-7279-4873-9ab5-cb53bad5928a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-05T18:52:05.3430762+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": "7f5fd22b-aa41-4bcc-9001-03a58915fb39",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-05T18:52:05.3430762+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.