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": "17bc344f-f85f-48a3-9113-d6b9093b332b",
"jobs_id": "51943da4-6714-4281-9df0-36080d1dd440",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "23e1f97e-9bc8-44fb-a8f8-d6176c6e9ca3",
"_parent_id": "281be352-86c5-4b24-81dc-5b7c7565ed88",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a7b5d0c6-b8e7-480a-8d4e-56ee02b6c51f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4405a1dd-0333-4b90-95ca-f00333a3c4fc",
"_parent_id": "af8d4953-a8ed-4f2a-b4b5-e26347e2ac5d",
"root_parent_id": "acd5a3ae-fd95-4325-9748-f32ad06e5032",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "c3f33c3c-511c-4f88-8c83-6abe8601395f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "fcc0867d-539c-4ea0-8c89-622abaaa0ee1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be6436c5-9def-41ea-97ec-4c853fd67362",
"_parent_code": "sample string 6",
"sales_organization_id": "f987474c-f785-4b0b-bcd0-22103843d47c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"equipment_model_id": "efdc0580-cd39-4cd5-bb66-f24f2ecf4da6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a2488be9-0069-453a-9ef4-dde12815e239",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "a953c98b-a64f-4e3b-89fc-906bc142be79",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1e076230-e643-4f25-a47a-49ee99d1b24e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2526afed-1c87-4728-ad0c-31229e9134a7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"equipment_family_id": "4821a01d-c0c6-4ee8-83a3-1c6f360f9bf0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "fcc0867d-539c-4ea0-8c89-622abaaa0ee1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "be6436c5-9def-41ea-97ec-4c853fd67362",
"_parent_code": "sample string 6",
"sales_organization_id": "f987474c-f785-4b0b-bcd0-22103843d47c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"date_in_production_since": "2026-10-20T18:52:00.8562753+00:00",
"date_out_of_production_since": "2026-10-20T18:52:00.8562753+00:00",
"date_end_support": "2026-10-20T18:52:00.8562753+00:00",
"sales_organization_id": "3a7f91f1-e12f-452c-bf8e-8e39c1c6dc97",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+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-20T18:52:00.8562753+00:00"
},
"project_status_id": "54b18e7e-f97d-448e-ae0b-05117e64069f",
"project_status_code": "sample string 10",
"project_status": {
"id": "481df77c-a8b0-4a18-8972-1078e356370e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "93c2100a-2ed0-48f2-874d-a1dd382d0437",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"company_id": "41168702-d583-4e44-9cfb-3da3b75c94f7",
"company_code": "sample string 12",
"db_address_id": "9506d58f-836e-4b10-aef0-e366b382c791",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8c9b432b-d9d8-4d14-a41c-41ceb67b1b63",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5354c0d5-c434-4040-b7dc-a150ad48bc68",
"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-20T18:52:00.8562753+00:00",
"date_create": "2026-10-20T18:52:00.8562753+00:00",
"date_update": "2026-10-20T18:52:00.8562753+00:00",
"updated_by_user_id": "5fb7a720-229e-48c6-b8a1-8160fd4c53e4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-20T18:52:00.8562753+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-20T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-20T18:52:00.8562753+00:00",
"date_last_job": "2026-10-20T18:52:00.8562753+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-20T18:52:00.8562753+00:00",
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00",
"is_mobile_installation": true
},
"job_type_id": "7b99414b-671d-4611-a1c5-346e75c220a0",
"job_type_code": "sample string 7",
"job_type": {
"id": "9e768f3b-ca22-4f30-a62f-04a7dea55dcc",
"name": "sample string 2",
"sales_organization_id": "1bab905b-0af8-4366-9b36-89bcdf6a0d0b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00",
"code": "sample string 7"
},
"job_priority_id": "0fce5a7f-9ef3-49e9-9d1b-538cc970b0c6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "67ca899c-bc78-44a1-9d22-47bb2870ec98",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "e1905545-19ef-43ec-af74-b0c215e2eba9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"job_status_id": "b0ace78d-15f1-4498-841a-03ee65b86b63",
"job_status_code": "sample string 11",
"db_address_id": "c2e87de8-e002-41b9-9e2e-9eecd64607ca",
"contact_id": "3dc772f7-005b-401d-b988-94e7bd125361",
"requested_by_company_id": "6dd864b1-90f1-4d77-b1d3-98b8635131a0",
"requested_by_contact_id": "e1d2237e-b3a4-4046-9988-1d60367d17d2",
"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-20T18:52:00.8562753+00:00",
"due_date": "2026-10-20T18:52:00.8562753+00:00",
"date_create": "2026-10-20T18:52:00.8562753+00:00",
"date_update": "2026-10-20T18:52:00.8562753+00:00",
"date_closed": "2026-10-20T18:52:00.8562753+00:00",
"suggested_user_id": "a55e938e-9b90-441a-b3cf-4fd5910937b4",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ca0f5c21-b7cc-47a7-ad12-a5ca5760a7f2",
"db_language_id": "bc674fe4-e199-46aa-a808-b60135fcffee",
"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-20T18:52:00.8562753+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "40a186dd-a399-48fa-b541-fb84b136f567",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ad2920fc-e041-47d6-b833-0b30d1de198d",
"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": "e45b1555-4b73-47a6-9fae-7c282774460c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d7651fed-2629-4106-ace1-01686fd98a70"
},
"suggested_date_start": "2026-10-20T18:52:00.8562753+00:00",
"skill_id": "d7e6417d-a95e-4ccc-9eeb-9056c2d97f37",
"skill_code": "sample string 32",
"skill": {
"id": "450f5a37-26bf-44ae-a9e3-8567925b302a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "156e838b-86a3-422c-854f-42be54254c0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "07730b88-30d2-4381-b715-0e8902ac0d06",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9250452e-e9b3-4cee-b8d2-18c80a1f523d",
"db_currency_id": "740dc8d6-6e89-4655-b233-70618cd08c51",
"db_language_id": "b9da7420-11df-424d-9648-fd0432db7d60",
"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-20T18:52:00.8562753+00:00"
},
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2522563f-0b62-4e6b-b055-a083c10f37fd",
"date_reported_by_company": "2026-10-20T18:52:00.8562753+00:00",
"id2": 36,
"company_id": "741262b5-7ceb-4368-a2c5-d3560dc94023",
"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": "627cf01a-1a20-4c05-9c14-3e126c34cbd2",
"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-20T18:52:00.8562753+00:00"
},
"work_instruction_details_id": "dff7d33a-e0c1-40b6-8d89-892a8fa6f494",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6deae300-de5d-4938-b4c7-1641ff4cf345",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fdfe150c-21d9-438e-828f-d1d0d13cebd5",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-20T18:52:00.8562753+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": "18e697e2-fee9-461c-b757-f73c3f03f80c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-20T18:52:00.8562753+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.