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": "6dfb8f69-3a20-4872-a458-86a26f30e01d",
"jobs_id": "16c70bda-0834-4c4b-b190-5b8252eb3bf3",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0c992e5f-d567-4f6c-b5a7-b8365c8b9a1d",
"_parent_id": "507f4ce4-ed1b-49a0-adac-394183a49e10",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2760a987-2057-4480-b465-b433d50f7c36",
"project_reference_back_office": "sample string 5",
"project": {
"id": "ccb9c605-fddf-4e96-b819-78eef880ef0f",
"_parent_id": "2d2c4505-104e-419f-851f-aa7c400130c7",
"root_parent_id": "e6e63c4f-2e03-4436-bc7e-cd73a5279b66",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "38a41071-d73a-4b3c-b028-e2c85dee11df",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "290e9b24-1700-4534-8d3a-facb7a025eab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "393dab4c-0df2-44a5-82d6-f6ffbdc753e1",
"_parent_code": "sample string 6",
"sales_organization_id": "122b431e-a8a7-4669-960d-acd898f09097",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"modified_dateutc": "2026-10-05T15:11:24.576473+00:00"
},
"equipment_model_id": "2d454ea6-b07c-46e0-92dc-8d5cf459e66a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "192159d7-a50b-4777-9fcb-85a525d5e833",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d64e5337-a511-46e7-b37a-153fcffc698a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "07df53cc-19c0-4f1d-82dd-73225c9a2cc8",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a702f2cc-23b0-483d-a5fa-64c68ae00611",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"modified_dateutc": "2026-10-05T15:11:24.576473+00:00"
},
"equipment_family_id": "12378328-4f4c-484f-8abe-ee5ccce828db",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "290e9b24-1700-4534-8d3a-facb7a025eab",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "393dab4c-0df2-44a5-82d6-f6ffbdc753e1",
"_parent_code": "sample string 6",
"sales_organization_id": "122b431e-a8a7-4669-960d-acd898f09097",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"modified_dateutc": "2026-10-05T15:11:24.576473+00:00"
},
"date_in_production_since": "2026-10-05T15:11:24.576473+00:00",
"date_out_of_production_since": "2026-10-05T15:11:24.576473+00:00",
"date_end_support": "2026-10-05T15:11:24.576473+00:00",
"sales_organization_id": "a6b072d0-2eed-4ec5-924e-12bf95a87fd5",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+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-05T15:11:24.590628+00:00"
},
"project_status_id": "f5b859eb-8b91-4104-b423-16339b2e92ad",
"project_status_code": "sample string 10",
"project_status": {
"id": "33ec9b9f-63c4-418a-ab74-e7c34235a68f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e18d1954-be27-4ac1-b356-085b009eda98",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T15:11:24.590628+00:00"
},
"company_id": "8e1174df-f7d0-46d7-8384-db46d1d36c32",
"company_code": "sample string 12",
"db_address_id": "fed24bb0-9334-4bf7-82f0-6776c5047ae6",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "dda101a0-4043-4052-8d18-28cf9f70b338",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "deef423a-a034-4ac5-a833-192d06a2771c",
"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-05T15:11:24.590628+00:00",
"date_create": "2026-10-05T15:11:24.590628+00:00",
"date_update": "2026-10-05T15:11:24.590628+00:00",
"updated_by_user_id": "6ad86340-c0d8-4a11-bf39-7f830af3c55f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-05T15:11:24.590628+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-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-05T15:11:24.590628+00:00",
"date_last_job": "2026-10-05T15:11:24.590628+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-05T15:11:24.590628+00:00",
"modified_dateutc": "2026-10-05T15:11:24.590628+00:00",
"is_mobile_installation": true
},
"job_type_id": "30b3822f-0a22-49bc-a4d0-4a64d9042036",
"job_type_code": "sample string 7",
"job_type": {
"id": "d501378b-a030-4d79-8991-4e0333485913",
"name": "sample string 2",
"sales_organization_id": "971845bc-5e28-4d1c-b6f1-cfee2f7bdda2",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-05T15:11:24.590628+00:00",
"code": "sample string 7"
},
"job_priority_id": "a6abc0f4-0669-4e98-8324-ffb1f30239de",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "be625597-db1d-4d7e-8ddb-2f9c98172b12",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25a39331-9e8c-43b2-844a-95f5f1c1e5ea",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-05T15:11:24.590628+00:00"
},
"job_status_id": "3e252040-5530-4340-baeb-9e5241b192c6",
"job_status_code": "sample string 11",
"db_address_id": "51442eee-9592-41a3-acf5-00c691d56037",
"contact_id": "76407577-605d-4a89-bdfb-eb80e255ff40",
"requested_by_company_id": "20a9fcee-6d78-4954-8acb-eced6082655d",
"requested_by_contact_id": "cb544148-5792-4024-94fb-48a5b458995c",
"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-05T15:11:24.590628+00:00",
"due_date": "2026-10-05T15:11:24.590628+00:00",
"date_create": "2026-10-05T15:11:24.590628+00:00",
"date_update": "2026-10-05T15:11:24.590628+00:00",
"date_closed": "2026-10-05T15:11:24.590628+00:00",
"suggested_user_id": "8f7dc406-1595-42d6-8f74-c38bfca6703e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "421c8c86-1dd1-4fd3-b021-fabbd5f56c5f",
"db_language_id": "8df7372d-afed-4ee8-a465-8203f6be84c2",
"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-05T15:11:24.590628+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ad07b383-263b-4cb2-bfef-2694a32f7de9",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "01c2be6f-b347-446b-a2e7-22580492da39",
"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": "6bc54966-ab30-42b1-99af-1b3e92be9945",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-05T15:11:24.6062556+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "84888654-a8ef-4661-bdaa-d73851693a8e"
},
"suggested_date_start": "2026-10-05T15:11:24.6062556+00:00",
"skill_id": "4e3b5828-d1a1-4e82-9c49-84f4a7db1b35",
"skill_code": "sample string 32",
"skill": {
"id": "8e7449db-9fe6-40fa-9e05-4dad804787fc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4d52f6f0-9ac0-4936-82c4-b8482dacab9a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dee0ea41-45d3-4813-96a3-65bb94de4cdf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0fb278f0-4820-4cd7-b7f5-a5efcb082bf2",
"db_currency_id": "45ba2aff-1c4f-40c7-b27e-6434936d4eff",
"db_language_id": "be5279bc-847f-4404-ae7b-80e8fc4c88d3",
"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-05T15:11:24.576473+00:00"
},
"modified_dateutc": "2026-10-05T15:11:24.6062556+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "76ffea1a-7af4-42e0-8e1a-b03b03e44610",
"date_reported_by_company": "2026-10-05T15:11:24.6062556+00:00",
"id2": 36,
"company_id": "d620a3f6-ae19-4ae2-989c-0bdf41589444",
"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": "2032ae0f-3c61-4dca-be0d-571cb16c5523",
"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-05T15:11:24.6062556+00:00"
},
"work_instruction_details_id": "1e6fc213-6dc1-4fd5-97d2-305a8fbcd561",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ed1fc902-4a1b-4e80-8797-ceac01cbf58d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "e7652aa1-0393-4718-a680-ce92d323ed2f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-05T15:11:24.6062556+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": "7ebc3125-5493-400d-9538-6be807f63c00",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-05T15:11:24.6062556+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.