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": "ba2adf48-ec69-4714-9e7c-4a1852147f76",
"jobs_id": "c1f50a7f-9d7e-45fb-bfe4-c2220980c120",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "18403e00-69f2-4f5c-9b63-cb9f8702dedf",
"_parent_id": "96be1bdb-60d9-400a-aad6-967184f6a2ef",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "bacaaffd-f66a-496c-afe1-4b0d99fbde74",
"project_reference_back_office": "sample string 5",
"project": {
"id": "23128ae7-2153-40df-b005-4d3835c253cf",
"_parent_id": "1d6e2a2f-a7a9-46a7-ae4a-1d9bbbe1d3b3",
"root_parent_id": "d385959b-e684-4f8b-89d8-7964fa440c5a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9cee39aa-5bd6-454f-a296-270cba81a2ff",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9d0505d8-ee92-47d9-a09a-be6f11542e77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7358c5b8-f36b-4f45-a3cd-416dfc925406",
"_parent_code": "sample string 6",
"sales_organization_id": "e739f219-5d2f-49fe-b6f2-910b35fae9cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00"
},
"equipment_model_id": "e48906b6-9b26-4eeb-8015-c8babcc81174",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "134531e9-a025-40ba-91b2-8d4f083c5dbd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "26b5f3de-9589-43fa-98ee-c33fbfaf9b62",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d8c348c5-edc1-4c89-b7ab-155c2715fae2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f7afd781-7bdb-46bd-b392-eb5b96c9d80e",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00"
},
"equipment_family_id": "61a769fd-21ee-414f-a591-60b1a1975075",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9d0505d8-ee92-47d9-a09a-be6f11542e77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7358c5b8-f36b-4f45-a3cd-416dfc925406",
"_parent_code": "sample string 6",
"sales_organization_id": "e739f219-5d2f-49fe-b6f2-910b35fae9cc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00"
},
"date_in_production_since": "2026-04-20T01:33:51.15281+00:00",
"date_out_of_production_since": "2026-04-20T01:33:51.15281+00:00",
"date_end_support": "2026-04-20T01:33:51.15281+00:00",
"sales_organization_id": "1360861d-1616-4388-9b8d-8c103233c08f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+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-04-20T01:33:51.15281+00:00"
},
"project_status_id": "63319b91-0794-45d9-b129-b1d75fb53cac",
"project_status_code": "sample string 10",
"project_status": {
"id": "abcb25df-128a-4b32-b08e-c4d8e5cf22b7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "1469bdff-c40b-47d2-80a7-024c5eefd762",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00"
},
"company_id": "3fae4955-84c9-4614-b023-ae8639eb45ea",
"company_code": "sample string 12",
"db_address_id": "256fa842-5d56-4e54-afe0-122c4b3da03e",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "45a1344c-5f75-4de0-bc30-00c68fcbebab",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b5c5087a-3aba-4b15-99cc-2bd835d13466",
"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-04-20T01:33:51.15281+00:00",
"date_create": "2026-04-20T01:33:51.15281+00:00",
"date_update": "2026-04-20T01:33:51.15281+00:00",
"updated_by_user_id": "2b276c02-7365-42d6-aaf4-0a632b021611",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-20T01:33:51.15281+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-04-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-20T01:33:51.15281+00:00",
"date_last_job": "2026-04-20T01:33:51.15281+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-20T01:33:51.15281+00:00",
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00",
"is_mobile_installation": true
},
"job_type_id": "028da00b-e041-4e65-9da9-e41b9665696f",
"job_type_code": "sample string 7",
"job_type": {
"id": "cf6cde2d-df6e-4569-afc3-12bcfc44c2a5",
"name": "sample string 2",
"sales_organization_id": "b041796c-ee8f-4016-8a25-30287b9b3b9c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00",
"code": "sample string 7"
},
"job_priority_id": "73a84ff2-3847-42be-b66d-a6b4639ffe8c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a69080fb-cc15-4de6-9f7c-ad5a6fca14b2",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ac37a3af-1f27-4f18-83a3-42fbb74e31ba",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-20T01:33:51.15281+00:00"
},
"job_status_id": "09e4f19a-fd0c-4e7b-93a9-75c6bffd6f1e",
"job_status_code": "sample string 11",
"db_address_id": "99e2556b-e6ff-49de-81cb-3c42c023926f",
"contact_id": "33268092-5e7b-438a-9886-cb7616690662",
"requested_by_company_id": "a5c40c58-08b8-43d9-9b56-ab946481dd6e",
"requested_by_contact_id": "2688ab12-2dff-4eb8-a10a-0523a633780b",
"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-04-20T01:33:51.15281+00:00",
"due_date": "2026-04-20T01:33:51.15281+00:00",
"date_create": "2026-04-20T01:33:51.15281+00:00",
"date_update": "2026-04-20T01:33:51.15281+00:00",
"date_closed": "2026-04-20T01:33:51.15281+00:00",
"suggested_user_id": "a3a1ee23-3815-42a5-839f-2db0d5951dbb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "019d2f19-f05a-432d-9692-31fdd40dde9b",
"db_language_id": "fb2a799b-de93-4330-a208-cd78b56d7139",
"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-04-20T01:33:51.1684278+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "72099806-e2ee-46b1-ac61-c3bfad875abb",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "5a9ad113-8fd9-4552-a667-d44420c70460",
"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": "20acd4aa-27fa-4b64-b739-7476822e5760",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-20T01:33:51.1684278+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "74ecf1c7-fee5-4662-810e-a8ff2a3c4fe6"
},
"suggested_date_start": "2026-04-20T01:33:51.1684278+00:00",
"skill_id": "ec93be8b-79a7-4a0d-9f0f-02e4425e4fc4",
"skill_code": "sample string 32",
"skill": {
"id": "92922217-83fd-48a5-b7eb-c7ebfc4fbb78",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "9d6ba4eb-7f2b-419a-a933-425b333e1e7d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "26d7e5ff-bbbd-49d4-9249-3db869eb3878",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73119089-e773-4bdf-98fb-297279148a6b",
"db_currency_id": "cdbf92ab-5c08-419b-bbc3-4af22654c2c5",
"db_language_id": "e3213da3-73cb-4bf2-9c4d-b4586035400a",
"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-04-20T01:33:51.15281+00:00"
},
"modified_dateutc": "2026-04-20T01:33:51.1684278+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "0df06006-a448-4ed0-8f5c-50baf751e55d",
"date_reported_by_company": "2026-04-20T01:33:51.1684278+00:00",
"id2": 36,
"company_id": "abb3b57d-888e-4ce2-bb03-acb1f5e15887",
"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": "0016f798-d8da-462a-8c10-ad244154c970",
"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-04-20T01:33:51.1684278+00:00"
},
"work_instruction_details_id": "be7df163-293a-4d3e-a3c5-3e2e0d5f12c1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a31664d4-427d-429a-8eb2-71ae651dca20",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ef1be33e-0c10-4f4d-85fe-3911d271a089",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-20T01:33:51.1684278+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": "1315c449-973b-48db-bd26-e002d728cd15",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-20T01:33:51.1684278+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.