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": "d256dd34-880a-4f45-9fe3-993bafe11451",
"jobs_id": "8c263530-b15c-4374-a827-bafb5b0cec95",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "84b45771-3b47-4ea1-98ec-103ce4e15e3e",
"_parent_id": "fc935133-8ab5-4cf5-9f18-92a898fa6586",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "87b6c495-5f78-47a9-87c7-0a18d8d26d4f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d2366a41-5a73-4d3e-b0ad-742f5873c197",
"_parent_id": "311881f1-59fc-4410-8430-5afeb572a6ac",
"root_parent_id": "fd2ba289-88ba-4ab6-b7d0-18ddfe46a6c6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2e8db153-73ce-4982-8677-01258065b655",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "015ad7b0-29bd-4200-b43b-5b5c102c90f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50ad4d5f-8027-4d71-81c1-16593808fae2",
"_parent_code": "sample string 6",
"sales_organization_id": "77c700ec-e7ab-4223-a7da-dc17fea52a4f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00"
},
"equipment_model_id": "a29b268e-86d8-4330-a4d0-b3af49da6884",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d55fa44f-7844-4e97-bbd3-00291eb2446d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f6f177c1-2561-499d-bf9b-c53ed849dccd",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a3d996f7-58a6-4beb-a213-0dc534dd9de8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2f9ba481-e793-4e93-9c5c-c6e477b378f0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00"
},
"equipment_family_id": "40b64392-7bf9-4bdc-ab46-16e71608feba",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "015ad7b0-29bd-4200-b43b-5b5c102c90f8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "50ad4d5f-8027-4d71-81c1-16593808fae2",
"_parent_code": "sample string 6",
"sales_organization_id": "77c700ec-e7ab-4223-a7da-dc17fea52a4f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00"
},
"date_in_production_since": "2025-12-29T07:54:22.8567586+00:00",
"date_out_of_production_since": "2025-12-29T07:54:22.8567586+00:00",
"date_end_support": "2025-12-29T07:54:22.8567586+00:00",
"sales_organization_id": "b02b6116-3b13-459f-8921-05b8d3953e5b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+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-12-29T07:54:22.8567586+00:00"
},
"project_status_id": "d5434f2f-d330-4947-940a-be4b487bb827",
"project_status_code": "sample string 10",
"project_status": {
"id": "5517a058-c496-4571-b48b-f8cd7aec3774",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8ba663a8-4553-4acc-b99c-2f9f55949a63",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00"
},
"company_id": "9d180e27-b5f7-4117-b4ac-2b6fbc8ca718",
"company_code": "sample string 12",
"db_address_id": "02ea269e-e2af-4e28-b809-589f5f431b7a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7df42a37-2b65-44d5-a632-684a6e9275f2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "9652ae89-aa6e-451c-b90b-0a7c7d19ca34",
"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-12-29T07:54:22.8567586+00:00",
"date_create": "2025-12-29T07:54:22.8567586+00:00",
"date_update": "2025-12-29T07:54:22.8567586+00:00",
"updated_by_user_id": "a3ddf636-3a5c-46a1-8b16-5b0d8329d93a",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-29T07:54:22.8567586+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-12-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-29T07:54:22.8567586+00:00",
"date_last_job": "2025-12-29T07:54:22.8567586+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-29T07:54:22.8567586+00:00",
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00",
"is_mobile_installation": true
},
"job_type_id": "3d7b0577-956c-49b7-b6f9-ef781fcfd236",
"job_type_code": "sample string 7",
"job_type": {
"id": "28578355-17f2-489c-bc87-0ff8b57d7178",
"name": "sample string 2",
"sales_organization_id": "6954c039-ca2b-4c6d-840f-acfccbe07f42",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00",
"code": "sample string 7"
},
"job_priority_id": "089d394a-195e-4c22-8b01-3dc89c3f98c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "14fe1caa-81e5-4a21-8f24-be71db301133",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b090e023-bc2d-4f7f-8ee9-a9aa0031dfad",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00"
},
"job_status_id": "7724ab0c-3282-4b4c-970a-0155212380c0",
"job_status_code": "sample string 11",
"db_address_id": "8ebce2e5-8848-4c66-9678-fe809fb61a06",
"contact_id": "a736b686-8c9e-4d26-9b48-6fdce988fab9",
"requested_by_company_id": "ebb74752-d3f6-4421-9996-8269f45864d1",
"requested_by_contact_id": "c22a04bc-2138-4552-ae8c-095ea7445cdf",
"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-12-29T07:54:22.8567586+00:00",
"due_date": "2025-12-29T07:54:22.8567586+00:00",
"date_create": "2025-12-29T07:54:22.8567586+00:00",
"date_update": "2025-12-29T07:54:22.8567586+00:00",
"date_closed": "2025-12-29T07:54:22.8567586+00:00",
"suggested_user_id": "c2c73910-9617-40a0-bb0d-deb16dc57b8b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "da1be364-e5a7-4481-80ad-a41e644fea42",
"db_language_id": "402b76ab-7383-4a02-b9e1-954705e5f639",
"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-12-29T07:54:22.8567586+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5ab1d483-bcf1-4fcc-8d8d-1d279400af77",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "58029f28-ec41-4454-a80e-962bae43ef00",
"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": "97b25cbd-e8fd-46dc-bfa7-5c9b42fe0ebc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-29T07:54:22.8567586+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "22ba7a17-a8fa-43c9-9a00-c6fa4ab88994"
},
"suggested_date_start": "2025-12-29T07:54:22.8567586+00:00",
"skill_id": "c8838671-1932-49de-9755-5b2d7d51dbc1",
"skill_code": "sample string 32",
"skill": {
"id": "b4d85116-6943-4ae0-98c4-943ab52d69e5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c94d77d3-850e-4fb3-99c1-7db69a124b5a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8e1f3de0-e044-48d4-9484-ddf2aa56338d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0970bf-d23f-4b50-8805-d5fcbea05190",
"db_currency_id": "2e59f1fb-da0c-4ae3-9438-7d5514189c9e",
"db_language_id": "fb94de17-e97d-4811-9ec7-380c643b244b",
"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-12-29T07:54:22.8567586+00:00"
},
"modified_dateutc": "2025-12-29T07:54:22.8723595+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a4d7445f-8b95-45b9-85fb-4621fbe4fc71",
"date_reported_by_company": "2025-12-29T07:54:22.8723595+00:00",
"id2": 36,
"company_id": "86e8fd65-7925-48de-b4c7-9b3a9565f941",
"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": "3869c71e-b61a-40d1-84d9-76baf1c50703",
"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-12-29T07:54:22.8723595+00:00"
},
"work_instruction_details_id": "d46dbab6-32fa-4312-a7d0-9f8237f9ee00",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f465751b-36c9-4dc5-bb1a-ec9d2b678829",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7c1efab3-8258-457c-a75b-31882b5cf73f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-29T07:54:22.8723595+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": "fe791005-080f-47a7-b37e-ca15c1579df0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-29T07:54:22.8723595+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.