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": "6e33ef1f-712b-43b3-9f2e-fde13e4007b2",
"jobs_id": "93a984cd-25eb-4b71-8300-e8a0cdcf02f0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "dfbe16df-e9aa-4310-94f0-690750eb19b0",
"_parent_id": "70b2742e-db13-41a8-a0d1-7a84ab54fbd4",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "9c27a2ab-0dc4-4913-98b6-f8a01aca3505",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e9771a92-6ed3-444c-9cd2-33d65caafefa",
"_parent_id": "a0ecabe0-26a2-4cfe-a059-7afcb9b040fa",
"root_parent_id": "420f7b32-0d7c-4c9e-a7d2-2b7166f423ff",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "940fd211-4d57-4086-8a70-1261584404c9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "308c9231-6453-408e-aeea-ae366413188a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "762694f1-01c6-4975-bbef-cc67059b6147",
"_parent_code": "sample string 6",
"sales_organization_id": "d7e9770b-4c2a-41be-ba68-a8e90977b12b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"equipment_model_id": "6b12315b-cb7b-4d51-a7c2-01ae4c6115d6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c08791de-4f95-43e2-803d-31473cc06ff5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d5a7a7f7-0e34-4d21-a17e-4e1eb8c3933d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6b00e8b4-334d-4e09-89a6-6ad0744a7278",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "564d4ff8-3ffb-41f6-ab82-d54b6a0aeb9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"equipment_family_id": "40272e76-1b7f-4047-a0ee-7f55124f8b7b",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "308c9231-6453-408e-aeea-ae366413188a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "762694f1-01c6-4975-bbef-cc67059b6147",
"_parent_code": "sample string 6",
"sales_organization_id": "d7e9770b-4c2a-41be-ba68-a8e90977b12b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"date_in_production_since": "2024-04-20T02:05:43.5430726+00:00",
"date_out_of_production_since": "2024-04-20T02:05:43.5430726+00:00",
"date_end_support": "2024-04-20T02:05:43.5430726+00:00",
"sales_organization_id": "eab56888-0740-4b92-962f-27c0b458fb02",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+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-04-20T02:05:43.5430726+00:00"
},
"project_status_id": "f57b2b98-4faf-46b6-9309-cd58cacc2de3",
"project_status_code": "sample string 10",
"project_status": {
"id": "7b1d90db-6cc2-4e37-a3b6-4559e21e131d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "347d3193-8109-4f4d-8853-094901bf3e2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"company_id": "f3c6fd88-250e-42bc-bdd9-3e95d4456a78",
"company_code": "sample string 12",
"db_address_id": "a0739469-84cc-4e30-866e-14a24d342ff0",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "fd4a9b47-286a-4fc3-8849-e1108023b869",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0e616352-f270-40cc-a12d-d6a54df3189e",
"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-04-20T02:05:43.5430726+00:00",
"date_create": "2024-04-20T02:05:43.5430726+00:00",
"date_update": "2024-04-20T02:05:43.5430726+00:00",
"updated_by_user_id": "3194551e-3d7c-4327-bf92-d7ca41d18ccd",
"customer_reference": "sample string 28",
"warranty_date_until": "2024-04-20T02:05:43.5430726+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-04-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2024-04-20T02:05:43.5430726+00:00",
"date_last_job": "2024-04-20T02:05:43.5430726+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2024-04-20T02:05:43.5430726+00:00",
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00",
"is_mobile_installation": true
},
"job_type_id": "3d26898f-a12f-4923-8991-64198a200cc8",
"job_type_code": "sample string 7",
"job_type": {
"id": "4df722c5-9693-44ac-845b-31e180fa9f39",
"name": "sample string 2",
"sales_organization_id": "c2bffeb3-6e13-4ebf-8a25-0f388ad8fe3b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00",
"code": "sample string 7"
},
"job_priority_id": "ce8d3185-3219-4dd0-a952-1d3852ff4b62",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1ab6b93f-c1b6-45d3-be66-8b7ce9b91079",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "22db2dc7-373a-40de-abd6-f107d9c216b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"job_status_id": "5e1d6c32-6cec-4a88-9196-02b8256579c3",
"job_status_code": "sample string 11",
"db_address_id": "93f22ef6-edf5-4339-aae5-8b882d085fb9",
"contact_id": "4dcf38ed-ad96-44b0-85fa-a0fc3e13baa9",
"requested_by_company_id": "8476c531-734c-4c99-a6cc-85628ffe372e",
"requested_by_contact_id": "f51f392e-eddd-424e-8f42-ae9d97aa545a",
"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-04-20T02:05:43.5430726+00:00",
"due_date": "2024-04-20T02:05:43.5430726+00:00",
"date_create": "2024-04-20T02:05:43.5430726+00:00",
"date_update": "2024-04-20T02:05:43.5430726+00:00",
"date_closed": "2024-04-20T02:05:43.5430726+00:00",
"suggested_user_id": "49560472-1c72-44e5-8424-c1f0fe81a0d6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7cc7dbab-9e35-407b-b3a5-e64c96879c0e",
"db_language_id": "4d399c33-31ff-4f73-aaf5-2205b1625e14",
"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-04-20T02:05:43.5430726+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "167c5bca-74e7-4834-8dda-aee61458af43",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "77885aef-2194-4313-9a31-26fa4b729e18",
"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": "c1c512ec-91b2-482f-b610-d9ace382f1eb",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "40b9eeb8-5752-49c7-bf0d-8738c5417b98"
},
"suggested_date_start": "2024-04-20T02:05:43.5430726+00:00",
"skill_id": "36224ad0-e0a4-475e-b05e-e676bcc19eb7",
"skill_code": "sample string 32",
"skill": {
"id": "114e2baf-430c-482a-8f5f-bd50bd5d44e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e19fd464-bcbe-4bfa-a22b-3aa837473106",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f04fee28-aeb0-4c8c-a982-7cf4689b4aef",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c5648c32-8eff-462b-bb4c-7949da3a4484",
"db_currency_id": "41d65ede-ee4d-42b0-ac0b-c12d8961f43b",
"db_language_id": "040863cd-6962-43a8-8551-71e27e50b954",
"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-04-20T02:05:43.5430726+00:00"
},
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f103aff3-198f-4f99-ac60-f2080b00a36c",
"date_reported_by_company": "2024-04-20T02:05:43.5430726+00:00",
"id2": 36,
"company_id": "4c54537b-9f77-4815-a800-8cd6ceea0027",
"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": "7f1945b8-4613-4d68-bf20-586175165df0",
"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-04-20T02:05:43.5430726+00:00"
},
"work_instruction_details_id": "9c5da2a6-0a2a-4fea-bb3b-d66e55a27fc7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ab351ff4-baed-433a-ad44-5b3d7ec7747e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7859ffe3-8db9-4906-a376-bad6930ba3e2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2024-04-20T02:05:43.5430726+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": "c0b11ea1-df19-4fce-b032-5b934be4cbdf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2024-04-20T02:05:43.5430726+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.