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": "82537d58-d60e-47de-9c71-d9ed48152d6c",
"jobs_id": "a464f33c-948a-4900-bb2d-d3259f31a8fc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c32010af-c6b4-4602-bc72-c61a26d19ed7",
"_parent_id": "5cebe706-50f0-4da2-bb87-4764a639d27c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "18816164-6333-42ba-a27d-2c4a401102dd",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c8a7b568-43f1-4a06-9b6a-1f87c3d5cc07",
"_parent_id": "05dac45d-dfb6-44f4-b3b5-f694279c1bc6",
"root_parent_id": "50d496ed-6956-4d0e-8996-704118b86324",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7f8e25c5-a166-46fa-964d-1008a0b473c3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a51fd670-804e-4dd6-af40-039d5c270a71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "900544da-6190-488e-93f1-9e860aa54259",
"_parent_code": "sample string 6",
"sales_organization_id": "7d013263-2277-4a84-bacf-beb1d9a3b889",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"equipment_model_id": "a3ff27dc-03b5-4867-9e98-e006ea3a6440",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "78660653-45e0-4530-aba5-d55aee0256d4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4c6f97a3-923a-4387-84de-677eae31e75c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97c952ac-20d1-437f-ab36-6f1f6492d83b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "56fe50d7-01bf-43ee-8ea8-5ebeffe4ced5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"equipment_family_id": "e13bf01b-9c5e-43bb-bd65-fcffe0be5435",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a51fd670-804e-4dd6-af40-039d5c270a71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "900544da-6190-488e-93f1-9e860aa54259",
"_parent_code": "sample string 6",
"sales_organization_id": "7d013263-2277-4a84-bacf-beb1d9a3b889",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"date_in_production_since": "2025-02-19T10:28:43.6204815+00:00",
"date_out_of_production_since": "2025-02-19T10:28:43.6204815+00:00",
"date_end_support": "2025-02-19T10:28:43.6204815+00:00",
"sales_organization_id": "6f17c202-80dc-42be-bcad-5acc66b5317a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+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-02-19T10:28:43.6204815+00:00"
},
"project_status_id": "ebf9a766-7a31-4a48-a9fa-f5e29bf3e5a4",
"project_status_code": "sample string 10",
"project_status": {
"id": "0d219d22-5139-4023-ba74-0c45f7bf73de",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "47c83766-c603-48e3-b3ad-9266e43bbc7b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"company_id": "c486e7b6-6ede-47d0-9c35-fd849f262788",
"company_code": "sample string 12",
"db_address_id": "32222cd0-e024-47a3-891d-498575c84a11",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e72be34f-55af-4184-9682-46fa432f8327",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4c62edc4-67cc-4133-ac91-73ed5691baab",
"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-02-19T10:28:43.6204815+00:00",
"date_create": "2025-02-19T10:28:43.6204815+00:00",
"date_update": "2025-02-19T10:28:43.6204815+00:00",
"updated_by_user_id": "c423fd75-82d6-44f3-ba47-179a602b9961",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-19T10:28:43.6204815+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-02-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-19T10:28:43.6204815+00:00",
"date_last_job": "2025-02-19T10:28:43.6204815+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-19T10:28:43.6204815+00:00",
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00",
"is_mobile_installation": true
},
"job_type_id": "800cf956-4167-4401-9655-ef15582f3e34",
"job_type_code": "sample string 7",
"job_type": {
"id": "9a21d2d4-8006-48b7-934f-0912daaf8124",
"name": "sample string 2",
"sales_organization_id": "3a257c89-32b9-42ed-b433-03e4d292cf9f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00",
"code": "sample string 7"
},
"job_priority_id": "097ad1f7-b5c6-4925-bab2-6addb38d4273",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cf2d3607-fc0f-41b0-b9ab-79aca87dfeaa",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "71abc86a-6f91-42d6-a9db-199d4c7a2209",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"job_status_id": "12681d95-90f9-487c-b5e5-cd1c8d093589",
"job_status_code": "sample string 11",
"db_address_id": "0f5ff92c-d733-4c31-9d0c-485de83f045e",
"contact_id": "20081f46-230f-4865-aeff-2cbfc78673d5",
"requested_by_company_id": "13988ca2-86ad-4409-9bb7-a1e0b53ee85b",
"requested_by_contact_id": "9d9e52f0-8eb4-475d-8fd6-3a3acbb30108",
"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-02-19T10:28:43.6204815+00:00",
"due_date": "2025-02-19T10:28:43.6204815+00:00",
"date_create": "2025-02-19T10:28:43.6204815+00:00",
"date_update": "2025-02-19T10:28:43.6204815+00:00",
"date_closed": "2025-02-19T10:28:43.6204815+00:00",
"suggested_user_id": "9609aec9-0131-45d7-8da1-0c63e5c7e6d8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fbec6484-0caf-4c38-b922-ab95eb55627c",
"db_language_id": "93ad9d8a-bd51-44f3-a333-e94fb13d9fb4",
"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-02-19T10:28:43.6204815+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "bda83978-7eee-46f1-a7d6-a6bf25b02511",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "3c8b9b23-c320-43ad-977b-dc4d1e555a84",
"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": "497a7b56-c930-4330-b9b9-0ae4925b544a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c33c9e4c-31da-4453-9f8c-4b03337906d5"
},
"suggested_date_start": "2025-02-19T10:28:43.6204815+00:00",
"skill_id": "5fe5dfce-a295-4fb9-ba05-05b1a24c9122",
"skill_code": "sample string 32",
"skill": {
"id": "56e49793-55ff-4f3d-998d-e02dae4cbfa7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e8bcc8cc-16dc-4720-9247-17cb821eb3aa",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "09a7e81e-f25f-4c0f-baba-d6ab07e2f52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cda3ff59-813d-4433-b4fc-d607bf311805",
"db_currency_id": "e1b6aea3-bda3-4a89-a20a-45546fcaaf4e",
"db_language_id": "c0f4c31f-061e-4f6b-b780-c0fbcc14b55c",
"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-02-19T10:28:43.6204815+00:00"
},
"modified_dateutc": "2025-02-19T10:28:43.6204815+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e9916dd0-dbe6-4554-a87c-51d017728b72",
"date_reported_by_company": "2025-02-19T10:28:43.6204815+00:00",
"id2": 36,
"company_id": "2918aa24-b928-453e-8924-df28ec36a54a",
"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": "9450936b-d38b-4a16-8a01-b8075cbe6e3c",
"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-02-19T10:28:43.6361081+00:00"
},
"work_instruction_details_id": "d799bab4-0291-4618-9984-55fd77f80fc7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8ae8583a-8556-4d56-a747-e4221f496103",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1ce71755-be67-4095-b418-a967e69daca4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-19T10:28:43.6361081+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": "acde3025-46d5-4404-935f-b510f1fd9cdc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-19T10:28:43.6361081+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.