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": "14339d5b-c31a-44d1-9c5e-15cc5a66a02e",
"jobs_id": "d5a74b9a-6880-4d9b-880f-db8b4a00d11f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c2544db0-03d9-436a-93a6-bbd0d5a02320",
"_parent_id": "19bd6fcd-cb27-4226-885e-0822abbe9ac6",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d4afbd1e-8717-47fc-99e9-5d6cf0f9d4ae",
"project_reference_back_office": "sample string 5",
"project": {
"id": "909ef49b-4ab3-4d48-bca6-e0dbdebe1671",
"_parent_id": "bcf3c85d-be53-4fa2-9100-9d5d4140ca39",
"root_parent_id": "453dfa74-e3bd-4a1f-a6c7-44de034c0645",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "fc78d3d4-ca9c-4b24-92c2-395da9778e8b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b4290e64-56b7-4899-8243-66c3c6f5df45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab4d3706-48d2-42c9-8aff-10beac7f73fd",
"_parent_code": "sample string 6",
"sales_organization_id": "37b918ce-ae03-4f90-8fb4-a91ea698a824",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"equipment_model_id": "59b46796-4c2d-42c4-a257-39afae13970f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "04de3106-766c-4dc8-93ba-943ac87c1af1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e363c618-d8e4-4a8e-b125-12b978fb5702",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "def1a152-bf3b-4dc6-a330-67406788752a",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e7da35de-f2fb-4483-8e7e-1bcc89bc95ea",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"equipment_family_id": "3433f83f-d761-4f54-ba5f-9f5e9015a478",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b4290e64-56b7-4899-8243-66c3c6f5df45",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ab4d3706-48d2-42c9-8aff-10beac7f73fd",
"_parent_code": "sample string 6",
"sales_organization_id": "37b918ce-ae03-4f90-8fb4-a91ea698a824",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"date_in_production_since": "2026-09-07T15:15:40.629806+00:00",
"date_out_of_production_since": "2026-09-07T15:15:40.629806+00:00",
"date_end_support": "2026-09-07T15:15:40.629806+00:00",
"sales_organization_id": "f2ba8e09-085d-48cf-831c-fc495fcedf14",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+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-09-07T15:15:40.629806+00:00"
},
"project_status_id": "5eadb64b-0846-4260-bdce-166dcc6152c9",
"project_status_code": "sample string 10",
"project_status": {
"id": "b98e10f3-3498-465c-a664-0e76bbc3ab52",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cf2092b6-6e8c-4c54-9ece-ec4b2adc8f77",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"company_id": "30a8b333-e705-4228-9c99-d5795a83a290",
"company_code": "sample string 12",
"db_address_id": "69d8382d-66c1-4078-b875-fb7083a0a3c3",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9d2f50af-a15c-44b1-82cc-ade15b579ede",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ec00648d-492e-434e-8cbe-b379c282c67f",
"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-09-07T15:15:40.629806+00:00",
"date_create": "2026-09-07T15:15:40.629806+00:00",
"date_update": "2026-09-07T15:15:40.629806+00:00",
"updated_by_user_id": "3fdfd77f-722f-4c6e-a885-06666c3c5c7e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-07T15:15:40.629806+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-09-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-07T15:15:40.629806+00:00",
"date_last_job": "2026-09-07T15:15:40.629806+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-07T15:15:40.629806+00:00",
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00",
"is_mobile_installation": true
},
"job_type_id": "c4f437a7-35a8-47ec-8e03-8f37e0ee9a12",
"job_type_code": "sample string 7",
"job_type": {
"id": "0f9aa854-d0fd-436b-8984-92f20489b636",
"name": "sample string 2",
"sales_organization_id": "5eab30eb-cc86-48bf-9a2a-bcf6ebfdfa6b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00",
"code": "sample string 7"
},
"job_priority_id": "0c3885b9-9c56-4a99-a8b2-e6903ea8812d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9f8b369d-010d-4773-89ee-7da5f974ad1b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d6d2994f-5549-4fd7-bc86-b8767b7d18b4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"job_status_id": "297eeb90-afd0-4774-903e-56a8e946040f",
"job_status_code": "sample string 11",
"db_address_id": "1fd672ce-9150-4c4d-b527-9ef798b04be7",
"contact_id": "45a016ae-aa89-473e-bb4b-21178e77c2c0",
"requested_by_company_id": "85e61a80-e190-4815-bc8b-9de09ea329e2",
"requested_by_contact_id": "ada3e6e1-768d-40f7-8e11-12480fedc018",
"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-09-07T15:15:40.629806+00:00",
"due_date": "2026-09-07T15:15:40.629806+00:00",
"date_create": "2026-09-07T15:15:40.629806+00:00",
"date_update": "2026-09-07T15:15:40.629806+00:00",
"date_closed": "2026-09-07T15:15:40.629806+00:00",
"suggested_user_id": "4ab95593-ed50-4a81-9b73-c89ae5c94467",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2a921524-7402-492c-b53d-60f0d9f32c30",
"db_language_id": "fd5b9077-e084-4fe4-87e9-81b49147bc8d",
"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-09-07T15:15:40.629806+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6b79fdd7-e707-422c-8223-f599b234a14e",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f321b32b-be19-47ba-8488-86e4f72b8d14",
"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": "68a7eee2-eb64-4956-a927-6bf9c4b09f68",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "a417d9cc-86e5-4c6f-b6e1-d81e88cd91f1"
},
"suggested_date_start": "2026-09-07T15:15:40.629806+00:00",
"skill_id": "611d299c-b698-419b-9f80-408e2c8086bd",
"skill_code": "sample string 32",
"skill": {
"id": "8da4694b-deb3-4b79-93b0-efee2cc696fe",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a518d9b5-3a15-4636-82ad-b2da30a338d8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2b844431-1ade-47ac-8705-2cd49888b3c2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "92ce2874-a555-486c-8fe7-c95933995b13",
"db_currency_id": "3c3f5e45-92d3-4eac-9b1c-a2e049d83b7b",
"db_language_id": "86e14dca-8634-4180-b9b0-50c3dea8ba8c",
"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-09-07T15:15:40.629806+00:00"
},
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "8ee54e4b-b1a3-4776-801f-5626d5ebfb41",
"date_reported_by_company": "2026-09-07T15:15:40.629806+00:00",
"id2": 36,
"company_id": "19f347b0-c0eb-4587-a242-b84992d6f79f",
"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": "1c81c4e9-22a9-48ca-88b9-0f88f438158b",
"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-09-07T15:15:40.629806+00:00"
},
"work_instruction_details_id": "f8317292-44ac-46ba-88f0-39f5c0b13dfc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "437f59a3-8cc9-45d8-b20c-44f6679deaab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "311b1231-2c18-4cfd-aca4-603bb77c9021",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-07T15:15:40.629806+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": "fcdd5637-4b22-4852-9bd7-4da8d99dc36c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-07T15:15:40.629806+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.