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": "64eb3259-ea03-4cee-b61d-c3787314c127",
"jobs_id": "f140464e-e977-4d12-aedf-0ff2409cb83e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9c2edaf3-998c-4aff-9e38-aa842f1b2cbb",
"_parent_id": "22d161eb-5f20-411e-aa29-2a76ba21362a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a98fea4e-0460-4cfb-98fb-76e482f138e8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7ae0f236-5525-4002-a484-90ee9a37cd21",
"_parent_id": "7fadfa83-d6c4-468d-9865-eeac284f0dbb",
"root_parent_id": "b090a2d3-98b1-4815-85b7-2a924717cefd",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "468a60ec-00a4-4b0b-ad39-675f204964a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "18c04785-8a05-42f9-8777-7c12fd3d815f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06c98189-d255-41b9-b051-a1aa146ae11b",
"_parent_code": "sample string 6",
"sales_organization_id": "2ff6c901-2a69-4965-9acf-fdd5eb6d3945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"equipment_model_id": "f9e82ebd-dd4d-41b0-bdfb-d2c9d964d956",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0999beac-0f3a-4e84-8454-566d5f5c31b5",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "724cc1b8-0033-4d6f-ae51-268172f6e96b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "571db2d3-2187-4da3-97f9-5e7a6d54e6fc",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "87b4d46f-45ce-4c2f-84f3-8bf414c29095",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"equipment_family_id": "fde556e8-e1c4-4ce5-999c-425690f9a5fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "18c04785-8a05-42f9-8777-7c12fd3d815f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "06c98189-d255-41b9-b051-a1aa146ae11b",
"_parent_code": "sample string 6",
"sales_organization_id": "2ff6c901-2a69-4965-9acf-fdd5eb6d3945",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"date_in_production_since": "2025-02-05T06:44:17.5297603+00:00",
"date_out_of_production_since": "2025-02-05T06:44:17.5297603+00:00",
"date_end_support": "2025-02-05T06:44:17.5297603+00:00",
"sales_organization_id": "6ad24331-0db6-4de3-b2ab-bd0c57f77934",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+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-05T06:44:17.5297603+00:00"
},
"project_status_id": "2b98916e-05aa-40b9-b9c6-cf726ecb887e",
"project_status_code": "sample string 10",
"project_status": {
"id": "388d725e-0abc-437e-a4e5-8760d987fb9a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8b5dd992-27aa-4375-830c-00312880d041",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"company_id": "0b914b32-dacf-4c3a-99ea-d1ca7b18dd0b",
"company_code": "sample string 12",
"db_address_id": "e34525fe-7096-40fb-815a-25ec8517c9cb",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5411b244-a4fa-4fb4-b0cf-173b326bd727",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "6de4c7ed-57a0-4eca-8f03-d1149c99f905",
"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-05T06:44:17.5297603+00:00",
"date_create": "2025-02-05T06:44:17.5297603+00:00",
"date_update": "2025-02-05T06:44:17.5297603+00:00",
"updated_by_user_id": "2b0004b8-6e13-40aa-9e53-dbe58f21e687",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-02-05T06:44:17.5297603+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-02-05T06:44:17.5297603+00:00",
"date_last_job": "2025-02-05T06:44:17.5297603+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-02-05T06:44:17.5297603+00:00",
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00",
"is_mobile_installation": true
},
"job_type_id": "b9838f61-c49e-4330-bdbe-0f2b25eda39a",
"job_type_code": "sample string 7",
"job_type": {
"id": "31ca9da0-93a2-4e71-a0e2-d4e7ff6cc1fb",
"name": "sample string 2",
"sales_organization_id": "4b9745fb-b610-4ad9-a6a3-888b2195c41b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00",
"code": "sample string 7"
},
"job_priority_id": "6d4a7430-f07d-4b30-8a19-298512d7aebf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "6715346b-c180-44c4-8f51-1e6c04817f8d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4dc6861e-ef78-46ab-bc3a-e723520f46a1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"job_status_id": "99b5d490-26e9-40ae-91d1-0135f87dec70",
"job_status_code": "sample string 11",
"db_address_id": "73abd7cb-8e7e-435b-a470-7bfb485e3fe5",
"contact_id": "6870b737-7dc3-4a28-88d6-9fc65770817b",
"requested_by_company_id": "c15fe8ec-17e7-46ab-895a-752872efcee8",
"requested_by_contact_id": "eec3384f-3832-413d-91f8-7c57f99fd796",
"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-05T06:44:17.5297603+00:00",
"due_date": "2025-02-05T06:44:17.5297603+00:00",
"date_create": "2025-02-05T06:44:17.5297603+00:00",
"date_update": "2025-02-05T06:44:17.5297603+00:00",
"date_closed": "2025-02-05T06:44:17.5297603+00:00",
"suggested_user_id": "8fd64bd3-903a-46f0-a2ad-4a92a9bf3b59",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0cf7f70f-3d44-4d65-a191-ab5130286199",
"db_language_id": "050eff3d-7d82-4f0b-8a66-8b7e4c6aa2b2",
"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-05T06:44:17.5297603+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "32fa3330-f4f2-4ea3-9a76-d281d918f4d1",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "819bdf2a-c249-4984-b7d1-6a94ab58aec3",
"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": "a4f1f1bf-825d-4848-a07a-7d0d6969c5aa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "09d49f6e-e17b-4400-991b-f23c9b572476"
},
"suggested_date_start": "2025-02-05T06:44:17.5297603+00:00",
"skill_id": "7ef64fb4-e778-48a4-81ae-96b13a3e767e",
"skill_code": "sample string 32",
"skill": {
"id": "26ca094b-cfda-4a42-9e57-dea2511d43e1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5b296af1-a877-469e-88f3-a03c4c47db9d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f68084a9-5ed2-4295-9829-b561f9e0966f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c94a8c95-d36d-4483-adcc-62cffa2d2698",
"db_currency_id": "95203dae-9741-4d87-98bb-74ec4f2d68c6",
"db_language_id": "e7563f0e-a816-4a1d-a0d7-add9c622fc11",
"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-05T06:44:17.5297603+00:00"
},
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "a641dab1-ab9b-47e4-a70c-c22da9044786",
"date_reported_by_company": "2025-02-05T06:44:17.5297603+00:00",
"id2": 36,
"company_id": "a0c7eeff-3983-48e0-9a3a-459cfc7816c5",
"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": "5acfdb96-a7c3-4d05-bf37-4ca67cc573a7",
"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-05T06:44:17.5297603+00:00"
},
"work_instruction_details_id": "6ad085fd-119c-443d-b880-3e20a12ae0c6",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "38fcd004-3425-4b71-a0ed-0b28bd03b0a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5613199e-d030-46b9-b1cc-29c8476e3db5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-02-05T06:44:17.5297603+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": "694838b9-52b2-429c-852b-143c615b28b4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-02-05T06:44:17.5297603+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.