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": "b8ec9a3a-27cd-4cf9-a6e6-d238c3b073fc",
"jobs_id": "9d2b530d-ed38-4b73-98c6-8de834ba34f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "49ffcf34-504f-4ead-acac-65a22e14732b",
"_parent_id": "5e45eace-0e7f-4c43-a691-b80c3da3fa68",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c9f69192-59c8-47f9-9729-a9449deb8167",
"project_reference_back_office": "sample string 5",
"project": {
"id": "dae9867b-9dbc-4f67-99fc-40dd17219d4a",
"_parent_id": "67106407-484a-4c8e-a0c6-6a6bc9e607ed",
"root_parent_id": "318bee99-e233-4ec3-8425-80326fd0f124",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9bde2b93-a2f9-4e59-b61d-f888af32c574",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "23f4b15f-b190-48c7-8b64-50019d23870d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e1f4dea-de2e-420d-b4ed-d5769fd66cb4",
"_parent_code": "sample string 6",
"sales_organization_id": "0fc735b8-55aa-4d62-aa72-079a55cba579",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00"
},
"equipment_model_id": "c2a6be8a-6865-4b2d-ba99-49b0861b426d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a818f80f-76fb-4053-afb1-72779464dd94",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f0de0c55-fac4-419f-b7dd-1b7a9bf4c7c8",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "30083054-f9e9-4219-be86-ec4e2f8c117f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "94f0426b-c42e-4003-8cce-2189baa6baf7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00"
},
"equipment_family_id": "46c89689-8c65-4997-a806-773387f165c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "23f4b15f-b190-48c7-8b64-50019d23870d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "4e1f4dea-de2e-420d-b4ed-d5769fd66cb4",
"_parent_code": "sample string 6",
"sales_organization_id": "0fc735b8-55aa-4d62-aa72-079a55cba579",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00"
},
"date_in_production_since": "2025-01-22T01:23:25.7069217+00:00",
"date_out_of_production_since": "2025-01-22T01:23:25.7069217+00:00",
"date_end_support": "2025-01-22T01:23:25.7069217+00:00",
"sales_organization_id": "cb37e03d-d619-415b-b800-e393659a045b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+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-01-22T01:23:25.7069217+00:00"
},
"project_status_id": "acc07705-431b-4a0b-ae1d-eafa4f5db296",
"project_status_code": "sample string 10",
"project_status": {
"id": "e1851512-b84c-47b9-a159-009085a407aa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3fe2f86b-da09-445f-b1ca-e0cc18d5afd4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00"
},
"company_id": "264d4f11-91c8-47c3-ba1c-4040ba24d3ba",
"company_code": "sample string 12",
"db_address_id": "a77e6c8e-ec2b-40bb-8523-1371a451e5a8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "21609750-6b5c-42c3-bc20-d241919fd629",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f078aadd-d00b-4f98-b5b7-d26f176ee923",
"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-01-22T01:23:25.7069217+00:00",
"date_create": "2025-01-22T01:23:25.7069217+00:00",
"date_update": "2025-01-22T01:23:25.7069217+00:00",
"updated_by_user_id": "238c57a8-1692-4cf5-8387-b543fb803a38",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-01-22T01:23:25.7069217+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-01-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-01-22T01:23:25.7069217+00:00",
"date_last_job": "2025-01-22T01:23:25.7069217+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-01-22T01:23:25.7069217+00:00",
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00",
"is_mobile_installation": true
},
"job_type_id": "d1d50c7a-f793-48a4-92e1-5512a8e54461",
"job_type_code": "sample string 7",
"job_type": {
"id": "9b99b3ce-2abb-4b6d-a745-38587ead0901",
"name": "sample string 2",
"sales_organization_id": "4a8c70df-ec28-470e-a964-539d2effa7cb",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00",
"code": "sample string 7"
},
"job_priority_id": "f1aee243-eed7-47e1-a9c3-b2a8ddc874ad",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a10fcd6e-bcb6-499e-84a2-3e80ce68cf5c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "5d9e910a-898a-4299-8831-ae234f4660f4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00"
},
"job_status_id": "db7c2b75-6e90-4ccd-922f-79556ba0110d",
"job_status_code": "sample string 11",
"db_address_id": "cf14946b-89b4-447c-84da-2a3e4a1f44be",
"contact_id": "356f12b9-4384-4770-aaf5-5a3e764c268b",
"requested_by_company_id": "773b196d-a571-4fbf-aa28-254fb3c9a0c0",
"requested_by_contact_id": "c2535f24-64d9-42fa-b613-966f1bc7222a",
"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-01-22T01:23:25.7069217+00:00",
"due_date": "2025-01-22T01:23:25.7069217+00:00",
"date_create": "2025-01-22T01:23:25.7069217+00:00",
"date_update": "2025-01-22T01:23:25.7069217+00:00",
"date_closed": "2025-01-22T01:23:25.7069217+00:00",
"suggested_user_id": "9c626fb7-19fb-4b10-856b-4fc6ff311d02",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2b8cbfcc-ffb1-4b4c-b640-fbc1dbc436af",
"db_language_id": "3836eb32-62f0-4af8-abf3-9b687fb8d1c5",
"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-01-22T01:23:25.7069217+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "983839c3-3280-4d89-a43e-140874d00d81",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "945b2e88-2309-4258-a22a-f92884ff61ba",
"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": "5a70a80e-8c67-4b5a-829d-392c11456556",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-01-22T01:23:25.7069217+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b1b27ccc-e53e-4289-8a77-b2a9aa1873a2"
},
"suggested_date_start": "2025-01-22T01:23:25.988171+00:00",
"skill_id": "54b1d230-3107-4c48-83d2-12932b78b916",
"skill_code": "sample string 32",
"skill": {
"id": "ffaa6782-c339-4c9c-a604-bc3c52168fd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "19318114-650f-461c-8299-e28f66e5f69c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "247116c6-399b-42e5-a062-a4fae9b1c0eb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "85da8ca0-4369-48df-963e-cc41545572d5",
"db_currency_id": "2650e42d-c907-40b2-9b0f-ae3ef3d496e5",
"db_language_id": "2649838a-7c69-4136-ba46-a0033d338ba2",
"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-01-22T01:23:25.7069217+00:00"
},
"modified_dateutc": "2025-01-22T01:23:26.0038114+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "bd2b7ba5-9af5-410a-9bf8-5c009daeb739",
"date_reported_by_company": "2025-01-22T01:23:26.0038114+00:00",
"id2": 36,
"company_id": "28e54c87-4e88-4798-9939-826e703a3ed2",
"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": "010dca72-75b2-4a69-a2e9-4f0ef93a292a",
"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-01-22T01:23:26.0038114+00:00"
},
"work_instruction_details_id": "1761e763-100c-4b4f-82a8-2f7dbe2d6d67",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "24d9389c-53f5-4535-a8c8-409d8d517bd6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "110006ba-09bd-4567-abdf-3794ca122cb3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-01-22T01:23:26.0038114+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": "5fa082a7-c435-4d93-84a1-0af2e87cb549",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-01-22T01:23:26.0038114+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.