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": "29857751-e2f3-4e41-adb3-52031895121b",
"jobs_id": "4a2bc9c0-50ef-4666-9132-48579b62d2ae",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3e211cb7-b5e1-42f5-b562-01a3d33009d2",
"_parent_id": "914201ba-abaa-4a65-aff6-de113bb86c73",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "76b8c0a3-690a-4172-8a7b-369eec9eb80d",
"project_reference_back_office": "sample string 5",
"project": {
"id": "68ce8372-bd09-4043-bc76-6459d4b2ca61",
"_parent_id": "e8da38f2-a954-482c-bb72-a91ef07f2050",
"root_parent_id": "cb813089-d36d-4708-aab8-e37e9023cd41",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "44dd1ea4-faea-49eb-81c3-09f226d91a69",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "de4cdf50-0fb1-4494-8ab9-405e2f7fde27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c35ea29b-b12a-48c6-bd0d-1b20553d4de9",
"_parent_code": "sample string 6",
"sales_organization_id": "158d98a9-e46e-4e78-aaa2-a750d60d42f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"equipment_model_id": "289ec81d-7751-4c8b-9e83-3f9a5e1f6650",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "93a4303d-4e67-465e-873c-1791a8f23fd0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9b23ca3a-7583-4a1b-83e2-cd098d9a341c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4cf604ec-c1b6-46fe-a59a-f94f620d94a6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f8074edf-f629-4a3d-8aac-d8997c75132a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"equipment_family_id": "4f5a9fca-4f17-443d-8f73-4f33841a900e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "de4cdf50-0fb1-4494-8ab9-405e2f7fde27",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "c35ea29b-b12a-48c6-bd0d-1b20553d4de9",
"_parent_code": "sample string 6",
"sales_organization_id": "158d98a9-e46e-4e78-aaa2-a750d60d42f5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"date_in_production_since": "2026-01-01T07:47:57.8159675+00:00",
"date_out_of_production_since": "2026-01-01T07:47:57.8159675+00:00",
"date_end_support": "2026-01-01T07:47:57.8159675+00:00",
"sales_organization_id": "07f304e5-0f91-4bf4-89bf-f5eccce52ddf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+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-01-01T07:47:57.8159675+00:00"
},
"project_status_id": "e328fc75-4163-44ce-bb07-0a6babe708ba",
"project_status_code": "sample string 10",
"project_status": {
"id": "44fe0217-913c-4089-b8cb-b554490e8baa",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "cbbba2e4-e5a8-4c1a-9d32-fb7933de4931",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"company_id": "c383472d-d839-4e39-853f-0bcaa1afcb14",
"company_code": "sample string 12",
"db_address_id": "95c0275a-cbb6-43e3-9fda-6bf38ba37c94",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "9d674740-5ba1-4e0c-a0b2-657c1323130b",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c0cf12ab-666d-4a24-b093-280e7abf36eb",
"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-01-01T07:47:57.8159675+00:00",
"date_create": "2026-01-01T07:47:57.8159675+00:00",
"date_update": "2026-01-01T07:47:57.8159675+00:00",
"updated_by_user_id": "9726a97c-1c4f-4af8-8f93-18536aef6fe3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-01T07:47:57.8159675+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-01-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-01T07:47:57.8159675+00:00",
"date_last_job": "2026-01-01T07:47:57.8159675+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-01T07:47:57.8159675+00:00",
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00",
"is_mobile_installation": true
},
"job_type_id": "248a7e9d-63ab-4136-b571-30fd44ee7883",
"job_type_code": "sample string 7",
"job_type": {
"id": "d2eb3c0e-71fe-4f2c-800f-bcbd154155e3",
"name": "sample string 2",
"sales_organization_id": "864719f1-2a30-4ef0-97e7-149a5a8be140",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00",
"code": "sample string 7"
},
"job_priority_id": "44800cfe-1a95-48b1-827d-58e491330fb6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "13c60456-a213-4170-aae0-500d7f38d3cf",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "25b9d03c-b9ca-4b73-820d-172f92cce48d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"job_status_id": "0105116a-b73d-4175-b908-b1724ff61319",
"job_status_code": "sample string 11",
"db_address_id": "dc63f46e-4673-41e3-9852-f4106f253600",
"contact_id": "5fa69d0d-528c-4546-8dc0-9aa902cae275",
"requested_by_company_id": "22222bac-0623-4f14-b2fe-6e03bffcafe3",
"requested_by_contact_id": "4bb96811-2f6e-45ed-921a-d7bafb4ac1ef",
"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-01-01T07:47:57.8159675+00:00",
"due_date": "2026-01-01T07:47:57.8159675+00:00",
"date_create": "2026-01-01T07:47:57.8159675+00:00",
"date_update": "2026-01-01T07:47:57.8159675+00:00",
"date_closed": "2026-01-01T07:47:57.8159675+00:00",
"suggested_user_id": "02e5a022-7ada-4aa1-a999-fa890a1918fd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "18bb8657-28cb-48bf-9245-b28239991539",
"db_language_id": "51a3445a-ab6a-4e1e-b8ba-3acd16e9c148",
"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-01-01T07:47:57.8159675+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1a221a5f-358d-4aa9-9556-9d5a415a33f6",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "878410a5-b0e0-498f-8834-91a7cf293827",
"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": "67b37612-7a8d-4eba-93b2-aa4dfe45ff2b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "52eddae0-2d6e-4b1d-be4b-95500f552146"
},
"suggested_date_start": "2026-01-01T07:47:57.8159675+00:00",
"skill_id": "8886f4dc-2bdc-4657-84c0-bec077858863",
"skill_code": "sample string 32",
"skill": {
"id": "9b25bc90-d47f-440a-97bf-d0e02e34ec3c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1acf810c-b1d3-43e8-92e7-b11c7021b281",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ec436383-856e-4559-8730-7ff49c3790f1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "df88ad0c-7a1d-4a8e-85d7-640a619e81dd",
"db_currency_id": "5da4638f-9a9e-46a2-8882-1caa8c2117dc",
"db_language_id": "6d3138ce-1ab4-4294-a918-8ca790db5132",
"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-01-01T07:47:57.8159675+00:00"
},
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7bc74b3c-827b-4686-9f08-c61d6f2b8194",
"date_reported_by_company": "2026-01-01T07:47:57.8159675+00:00",
"id2": 36,
"company_id": "85875d8d-2485-43a0-95db-55e686682d05",
"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": "1b532c4e-457c-4ddc-bc4d-0343d20dbf4c",
"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-01-01T07:47:57.8159675+00:00"
},
"work_instruction_details_id": "57682c74-0d19-4e50-8ce3-2af46a43944e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "532a0083-a51f-4612-b624-bda9d19cacb1",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3fbd6e9f-27b8-49aa-a552-1fd198889773",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-01T07:47:57.8159675+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": "40bed18e-0d0e-4a1f-815a-38d7f270d34a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-01T07:47:57.8159675+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.