Creates a new job work instruction list.
Request Information
URI Parameters :
None.
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": "4655a561-71dd-400e-90e1-993ce2587b39",
"jobs_id": "a6c38644-cfae-422e-8273-e6fb0265d176",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "84c6bc25-8507-42f6-a38b-4a3356bd2cf9",
"_parent_id": "a7715ef0-f2f1-4f76-9777-cf1c0522b2f5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "cf6f9b65-7860-44ff-a03d-d3fccdbf10f8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "48c003b4-3afb-4772-a2da-38fc93456fd2",
"_parent_id": "6d25c0a1-1b7d-4ba8-9220-1c4bd52169c6",
"root_parent_id": "2a2b4699-13fa-4772-863a-2f1bc9303833",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "df954c8d-d4e9-4631-9c33-5ba66cc30c34",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "8e3835f6-dfad-4aaa-b005-1a17c7e2ef71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb012e1e-4793-4338-bdb9-964bb0381126",
"_parent_code": "sample string 6",
"sales_organization_id": "77209039-ed9f-4a6a-a73e-8335846daa24",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"equipment_model_id": "546851b6-6236-48dc-b1d9-f39ce91c8cec",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cda4fd30-8240-496d-afb6-a8bb3aff6a77",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a6315196-bad2-490f-a074-7c19f6b852f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "131fb99b-d1d6-4710-9bc9-47fe934b4d4d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c673ef7d-cd34-4aef-977c-e28fc9d408ec",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"equipment_family_id": "85fbe970-f74a-418b-89c5-b1fdd43c5149",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "8e3835f6-dfad-4aaa-b005-1a17c7e2ef71",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cb012e1e-4793-4338-bdb9-964bb0381126",
"_parent_code": "sample string 6",
"sales_organization_id": "77209039-ed9f-4a6a-a73e-8335846daa24",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"date_in_production_since": "2026-05-07T20:55:50.4275698+00:00",
"date_out_of_production_since": "2026-05-07T20:55:50.4275698+00:00",
"date_end_support": "2026-05-07T20:55:50.4275698+00:00",
"sales_organization_id": "d2327610-5be9-4053-acd2-8d20e74481c7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+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": "2026-05-07T20:55:50.4275698+00:00"
},
"project_status_id": "22011abb-9391-4107-8625-51ed54c21319",
"project_status_code": "sample string 10",
"project_status": {
"id": "d83b64d1-f75c-4ed2-96cb-b66c231ecf21",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e40a7cb3-3f47-44c3-89a7-4bdba64f230b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"company_id": "4902f42d-cc32-4d68-9142-c8648d7f6fce",
"company_code": "sample string 12",
"db_address_id": "616a59c1-8636-4501-bb7d-3661d4cff9d9",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7591dece-303f-4177-8581-5e02c8dd0b5d",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e821c522-cedf-4849-b1f5-2c69de2d1054",
"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": "2026-05-07T20:55:50.4275698+00:00",
"date_create": "2026-05-07T20:55:50.4275698+00:00",
"date_update": "2026-05-07T20:55:50.4275698+00:00",
"updated_by_user_id": "dcedc446-32d4-4bdc-a982-6e13b0bc7117",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T20:55:50.4275698+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": "2026-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T20:55:50.4275698+00:00",
"date_last_job": "2026-05-07T20:55:50.4275698+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T20:55:50.4275698+00:00",
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00",
"is_mobile_installation": true
},
"job_type_id": "d438d6c2-c688-41cd-b472-3ad89427cfaf",
"job_type_code": "sample string 7",
"job_type": {
"id": "f8e41833-08bb-4c0f-9f5c-ef63cea46850",
"name": "sample string 2",
"sales_organization_id": "120c43da-c6d9-4654-99fd-c0c20ebfd298",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00",
"code": "sample string 7"
},
"job_priority_id": "a7ad7d4b-c18d-46d5-8796-4dc950b3b055",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e3ed8341-f45e-4840-81ce-8a2146b228a2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9a47dfd6-a2aa-4430-8495-56109e738a96",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"job_status_id": "d04ad7df-2e14-4739-a475-57a88efabb54",
"job_status_code": "sample string 11",
"db_address_id": "60e59713-26d3-4e92-b6fe-ae77647c92c9",
"contact_id": "a6e2eb10-8f3f-4a65-8a1b-a8fe17d59b2b",
"requested_by_company_id": "800348f0-2cb1-427e-a614-b94334c38c5b",
"requested_by_contact_id": "7434688d-7dbd-4729-8681-5f0d54eccf3c",
"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": "2026-05-07T20:55:50.4275698+00:00",
"due_date": "2026-05-07T20:55:50.4275698+00:00",
"date_create": "2026-05-07T20:55:50.4275698+00:00",
"date_update": "2026-05-07T20:55:50.4275698+00:00",
"date_closed": "2026-05-07T20:55:50.4275698+00:00",
"suggested_user_id": "270e1dd8-f734-4e45-bf82-367e27613da5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "104d8a00-dfd5-4572-9879-5b8e1824e44a",
"db_language_id": "e310eedb-9a62-4526-bca3-280e93f9646b",
"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": "2026-05-07T20:55:50.4275698+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ec8ef69f-cf16-40c8-a0ff-36792586a6b0",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4550a0ac-6633-469d-affc-a31721e00700",
"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": "9ede9d49-5a01-4975-81a9-45f58288adce",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5f7a13b9-9f98-48a4-a7a9-ad9ccb350c8b"
},
"suggested_date_start": "2026-05-07T20:55:50.4275698+00:00",
"skill_id": "02f51c63-2978-46ca-a020-40c9219a35f3",
"skill_code": "sample string 32",
"skill": {
"id": "ec036a8f-c952-4e19-8bd1-8518ab4c40e0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "eba66634-c6b4-4ac9-90c1-b0e581e1be40",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e62c5fe7-5a94-4bef-a6ab-7602694c0b6f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "94ad282c-6719-45c2-a467-1f996e4416d0",
"db_currency_id": "2a0e60e9-255f-4d5c-b69a-04e9860f33be",
"db_language_id": "f2835b20-271a-441c-adb4-d8efdef5c3f0",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8719256b-40b3-4489-8cbf-ee188f6c522d",
"date_reported_by_company": "2026-05-07T20:55:50.4275698+00:00",
"id2": 36,
"company_id": "ea140242-fec6-4d9b-b689-5dc741fde8be",
"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": "deac0300-90bc-41bb-9d76-7d0bafc74fdc",
"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": "2026-05-07T20:55:50.4275698+00:00"
},
"work_instruction_details_id": "29130a26-4b26-4964-a6cc-10ba29eafad0",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e62fbd39-386a-4fc3-a6d4-ccd666f37b98",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9649a408-ca32-4f45-96a5-cdfee0025a00",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T20:55:50.4275698+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": "4532352e-2697-4be2-83a5-fdb5335b8515",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T20:55:50.4275698+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.