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": "83eaee8f-3bfc-40f5-b812-e3c12d0ecaf8",
"jobs_id": "8d35fe56-8b71-45a2-83a6-17ff59e51177",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3c45f3cc-85e4-487a-9251-1627fc807666",
"_parent_id": "40eba780-9a14-4631-b6a7-4dcfff17e31a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2e0d75d8-6d69-4cae-bbc8-67cbea3cda2d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "86feda11-8eae-4d52-81d8-499d5249cd71",
"_parent_id": "197f0c1e-d3f9-4938-91c7-460a5daa0bec",
"root_parent_id": "52e25c5b-4789-4cb4-bf99-ce7603ff5f56",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f099c320-e172-4b4a-82d3-f8be74077ea5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "ab1f1c1a-24d6-449a-bf4c-3da9060a274e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a420618c-e068-41c5-86f3-f7e16ed73d00",
"_parent_code": "sample string 6",
"sales_organization_id": "6b5e21ca-0cb1-4dfd-9b29-412b49e1ffa6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"modified_dateutc": "2026-10-24T07:00:21.4258852+00:00"
},
"equipment_model_id": "0df11401-d497-4696-9a63-84a386be134e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b37640b1-e2e2-4e06-822e-b1fdfafd3c32",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0bb92e9b-65ae-4356-a929-6c69acb1400a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "97015c1d-f10c-473b-b9b5-869654ff92c1",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "734a33f2-d035-4841-9bca-0da8e77ab3d9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"modified_dateutc": "2026-10-24T07:00:21.4258852+00:00"
},
"equipment_family_id": "903d60c8-a5c0-43e8-96ec-7c72898caa47",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "ab1f1c1a-24d6-449a-bf4c-3da9060a274e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a420618c-e068-41c5-86f3-f7e16ed73d00",
"_parent_code": "sample string 6",
"sales_organization_id": "6b5e21ca-0cb1-4dfd-9b29-412b49e1ffa6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"modified_dateutc": "2026-10-24T07:00:21.4258852+00:00"
},
"date_in_production_since": "2026-10-24T07:00:21.4258852+00:00",
"date_out_of_production_since": "2026-10-24T07:00:21.4258852+00:00",
"date_end_support": "2026-10-24T07:00:21.4258852+00:00",
"sales_organization_id": "3c2c619a-bea9-46f2-8667-3629a7b6b6b9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+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-10-24T07:00:21.4258852+00:00"
},
"project_status_id": "96fa5ac9-c670-448e-94bc-71e8c8d43476",
"project_status_code": "sample string 10",
"project_status": {
"id": "15465df3-2e69-44f0-8554-46e82d26b0f9",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "796b029f-a4c3-4058-b851-00e31dc88478",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00"
},
"company_id": "cb4bddac-36fe-4ec5-9f12-712cf90671f9",
"company_code": "sample string 12",
"db_address_id": "b736e2bf-48f5-484a-96d4-dc1104053ebd",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9a565784-6378-46f3-9e50-ffb0399cff0a",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "a896b205-a01f-4958-92b2-e80722a59494",
"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-10-24T07:00:21.4432605+00:00",
"date_create": "2026-10-24T07:00:21.4432605+00:00",
"date_update": "2026-10-24T07:00:21.4432605+00:00",
"updated_by_user_id": "49a6344d-38d2-412d-8612-cae490f1fffe",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-24T07:00:21.4432605+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-10-24T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-24T07:00:21.4432605+00:00",
"date_last_job": "2026-10-24T07:00:21.4432605+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-24T07:00:21.4432605+00:00",
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00",
"is_mobile_installation": true
},
"job_type_id": "a1009ac8-e475-488d-b505-7a7c22a7a796",
"job_type_code": "sample string 7",
"job_type": {
"id": "d0a49d0c-0270-4cfc-945f-f3e850dfad9a",
"name": "sample string 2",
"sales_organization_id": "8e7c5892-8685-470a-84b5-5f76a6dd1576",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00",
"code": "sample string 7"
},
"job_priority_id": "eba4efc9-b57b-486d-8478-bb2c3699dfc3",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a5579d19-cb86-45ab-81f9-0dcaf5baaf1e",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "07bd2311-e01c-4c33-9a44-88055dc5accc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00"
},
"job_status_id": "19cdf85f-dcdb-4ffc-aa0e-df2eec8fd96b",
"job_status_code": "sample string 11",
"db_address_id": "86eb1aeb-d0a8-424a-9754-88057303556e",
"contact_id": "90a98a45-62f7-4c7e-b63d-3d3a86f17ce8",
"requested_by_company_id": "d1180b00-70e6-448e-8260-59df82a055b5",
"requested_by_contact_id": "a0d0f8c6-5430-42a6-99fb-5dd8b22a5529",
"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-10-24T07:00:21.4432605+00:00",
"due_date": "2026-10-24T07:00:21.4432605+00:00",
"date_create": "2026-10-24T07:00:21.4432605+00:00",
"date_update": "2026-10-24T07:00:21.4432605+00:00",
"date_closed": "2026-10-24T07:00:21.4432605+00:00",
"suggested_user_id": "f6cc146f-68f0-4c6a-86ca-b9946256d69c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "614c574d-0532-42d9-bf0f-4fa57a65b1d7",
"db_language_id": "2f684e30-e02a-41cd-9fb1-52ecfdc14ce7",
"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-10-24T07:00:21.4432605+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c63bf9c0-7dfd-42d3-966a-494ef5422088",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fe8dc0c3-5ef8-4961-970d-d80ab138e27e",
"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": "4acf2eec-4fd4-4ffb-9460-def88db04418",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "404d9881-d147-4498-b46f-13b08a282c1d"
},
"suggested_date_start": "2026-10-24T07:00:21.4432605+00:00",
"skill_id": "227ec538-c9ca-46bd-943c-a6237d13eda7",
"skill_code": "sample string 32",
"skill": {
"id": "e057b1f4-b3d2-450b-9fd6-a85e5d6e00f0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3ecd1eac-44e7-441a-a0e9-3a15a35db6b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "be4123f9-0818-48f5-96df-1e7f3eff6c2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "72e1481d-0bdc-49ce-b7cc-976f072d050f",
"db_currency_id": "2c1c33de-ea98-4fa6-aa60-5145b44edb32",
"db_language_id": "33d8ca1c-46a3-4132-8657-456430b36d34",
"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-10-24T07:00:21.4258852+00:00"
},
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f0b4c2be-a790-48f6-ba2d-55ad99dafb6a",
"date_reported_by_company": "2026-10-24T07:00:21.4432605+00:00",
"id2": 36,
"company_id": "2bd955ed-a12a-4d4b-ab1f-ff81d1ca7bf6",
"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": "adec5cf1-697f-4303-87f1-878b3840305e",
"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-10-24T07:00:21.4432605+00:00"
},
"work_instruction_details_id": "47c051e0-6149-4ed1-b2b8-0921bf3ec1e7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3f80a17a-10db-4011-909c-fca5edc288f4",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "29ec5994-7639-4b78-bdc1-ff7537f23817",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-24T07:00:21.4432605+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": "f4620e4f-7fa8-47ee-b851-426c1b1d96e5",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-24T07:00:21.4432605+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.