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": "a0d94446-d253-4dcb-b42e-1110b986337e",
"jobs_id": "61905546-f24d-4f52-987d-ac16c5f3cfdc",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "1d2b5112-1dca-49c9-93d6-b744b81043ea",
"_parent_id": "dcf07527-933e-4323-b3d9-8c579b358dd8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "14c01c0c-efef-4791-b08b-1aaf0eb6c835",
"project_reference_back_office": "sample string 5",
"project": {
"id": "32b03d9e-b0f3-4975-ac4a-8e4e643bbda5",
"_parent_id": "e0209573-85f5-40c7-828e-71a92a1698be",
"root_parent_id": "a09579b2-3cda-48bb-ba46-a4320ecc5619",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fc5f2a88-bdfb-419a-9f81-0e2338c0f20f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5455057d-8fbb-409b-905f-fb18bc336235",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b2ed3da5-1649-4b18-8315-0cf5603a5781",
"_parent_code": "sample string 6",
"sales_organization_id": "2caa6088-da9a-4505-bdaf-b9d116d3ad49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00"
},
"equipment_model_id": "ff17a38a-0a4d-4872-8ded-2a3449ab7fc7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3d740f31-471f-484f-9c96-7189028b9f87",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3c83f658-473b-42e2-8e4e-3284f87e2590",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "111e68a3-465e-4b24-8975-aa685c19b293",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "84b059a7-ddc9-485b-b65b-792297659b17",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00"
},
"equipment_family_id": "9b79e592-ae30-4ffc-9496-7b248683a7c3",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5455057d-8fbb-409b-905f-fb18bc336235",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b2ed3da5-1649-4b18-8315-0cf5603a5781",
"_parent_code": "sample string 6",
"sales_organization_id": "2caa6088-da9a-4505-bdaf-b9d116d3ad49",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00"
},
"date_in_production_since": "2025-05-16T06:24:18.5759456+00:00",
"date_out_of_production_since": "2025-05-16T06:24:18.5759456+00:00",
"date_end_support": "2025-05-16T06:24:18.5759456+00:00",
"sales_organization_id": "b3d74c51-70c0-4e21-a82e-0c85b5cb7dbb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+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-05-16T06:24:18.5759456+00:00"
},
"project_status_id": "a30ac207-6a5a-4c09-a8bc-d78f27ea9eaf",
"project_status_code": "sample string 10",
"project_status": {
"id": "6f5d3b47-72ad-419b-aea7-4d98600d0448",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "434e56b8-57f3-4521-bf99-31be793f0e28",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00"
},
"company_id": "8368559c-4cb7-4455-8a07-0a7ff172d0a2",
"company_code": "sample string 12",
"db_address_id": "377ee913-9d21-45b8-81d5-8b8a8724812a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1d4d2707-d6af-48f4-b54b-968cfc74a8e3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d46e312c-510b-474c-87c3-e1f5ee908762",
"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-05-16T06:24:18.5759456+00:00",
"date_create": "2025-05-16T06:24:18.5759456+00:00",
"date_update": "2025-05-16T06:24:18.5759456+00:00",
"updated_by_user_id": "7fe9bfd1-9e6d-4f0b-bb63-0eb03f26dc40",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-16T06:24:18.5759456+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-05-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-16T06:24:18.5759456+00:00",
"date_last_job": "2025-05-16T06:24:18.5759456+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-16T06:24:18.5759456+00:00",
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00",
"is_mobile_installation": true
},
"job_type_id": "27b4bc35-6cef-47ff-85f1-8e5b09234f16",
"job_type_code": "sample string 7",
"job_type": {
"id": "e87c8106-8a5d-464e-9169-ae7f54f7b162",
"name": "sample string 2",
"sales_organization_id": "b45a76d3-fefc-41f6-9134-bfc211d5ef6c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00",
"code": "sample string 7"
},
"job_priority_id": "54274df9-de6f-4c90-956a-d72e15dc7631",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a34d8de4-4cee-4d78-8bab-d0a4d9dbda76",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7544a16d-92f5-45db-9fa1-26b7927a0787",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-16T06:24:18.5759456+00:00"
},
"job_status_id": "4ea1d670-edd5-4711-abf3-ace88a4d47e3",
"job_status_code": "sample string 11",
"db_address_id": "0be038eb-5643-4d1f-a85c-404dd8a4d935",
"contact_id": "2ea42f06-b22d-4032-861c-0bc098a193b4",
"requested_by_company_id": "103fa293-e94b-415b-860c-d411753c8590",
"requested_by_contact_id": "048ef3e3-bc83-4c99-bc1b-dda93e1db723",
"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-05-16T06:24:18.5759456+00:00",
"due_date": "2025-05-16T06:24:18.5759456+00:00",
"date_create": "2025-05-16T06:24:18.5759456+00:00",
"date_update": "2025-05-16T06:24:18.5759456+00:00",
"date_closed": "2025-05-16T06:24:18.5759456+00:00",
"suggested_user_id": "dc5c2559-80fb-435f-9b54-d3efd09ca45b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1f317ef3-a80e-49cc-a725-e913cfaa06f8",
"db_language_id": "bc7b1531-43ea-4f15-b2b5-80b1f798a72f",
"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-05-16T06:24:18.5759456+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "78d1923e-d5ad-47cd-8cfc-b5fb7f25f431",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "dc58a2b3-1adb-4325-a4fb-ab55c4a2f51e",
"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": "3de25694-69c8-4584-a702-bd829bd0d3f3",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-16T06:24:18.5915705+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3a157cce-1d8a-4368-9470-db9be8b5a4bd"
},
"suggested_date_start": "2025-05-16T06:24:18.5915705+00:00",
"skill_id": "eb3e0f0b-0017-4955-bf20-2ec9d1623941",
"skill_code": "sample string 32",
"skill": {
"id": "cc63ee6a-3ba9-4ce8-a71a-e63219be53c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4e28254b-1ae0-4310-af65-31db6fb16c13",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ecb17bea-992f-4f82-8b30-9a3fae5a6755",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f20d5db9-6589-4f01-98c2-9cde1660fc22",
"db_currency_id": "4bf031f2-efe8-418d-a971-9eafe2d0a50e",
"db_language_id": "c0761dc6-e909-45c0-9c2c-dbddffa52e74",
"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-05-16T06:24:18.5759456+00:00"
},
"modified_dateutc": "2025-05-16T06:24:18.5915705+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c1f6cdfe-c05e-4f36-ac31-52b9d03a8410",
"date_reported_by_company": "2025-05-16T06:24:18.5915705+00:00",
"id2": 36,
"company_id": "1b210c9e-e917-498b-8ba7-a7a16c421eb5",
"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": "b2664d03-d40d-4255-8ac1-9e7f87ca4417",
"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-05-16T06:24:18.5915705+00:00"
},
"work_instruction_details_id": "39b038d8-b79f-48bc-8e86-df66d38e8947",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0bac88b7-a86b-4c73-9d57-9f89b0adfc33",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "7900832e-0d66-4347-a76b-8f5a0c01417a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-16T06:24:18.5915705+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": "67818e00-a583-4491-8de2-03962fced143",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-16T06:24:18.5915705+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.