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": "03970f2a-0ef7-4696-801c-efb15998129e",
"jobs_id": "aebc7e57-ddc7-474b-916a-e6329c261960",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ac0fd9ca-ccc7-47cb-a230-93f8f823efb5",
"_parent_id": "561949ac-f6ed-4203-a8df-e5349f35b0fd",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6a5cf967-282d-41a3-b4d8-ee44afe59a5e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c4779ad5-ac88-43c4-913b-c645c2f46e92",
"_parent_id": "6e14b1fc-7108-4ce0-ad70-1a1bad467cf0",
"root_parent_id": "60ee0ca9-24f1-47d4-be8b-2201d6ee0ba4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e329453d-1ebd-4947-88c0-e3a274a955d7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "e7d1c72e-3ee5-4ab3-80b3-6e8ac43481de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf8a15e1-14d5-422a-a668-ad559ae7d48a",
"_parent_code": "sample string 6",
"sales_organization_id": "2d19c777-c5b9-401b-9b38-6db319102c76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"modified_dateutc": "2026-05-30T12:38:18.8177693+00:00"
},
"equipment_model_id": "0930da79-e0e9-465d-a7b2-7645322ae9e8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b872c87a-3ab2-4445-b297-2c19fd26e0d2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "291db439-a132-4987-b2d2-44cf527461e4",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "f6914208-9823-4cae-98c8-17a96767cf8b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "4a06024d-c6f7-45bb-9207-4d256298bd9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"modified_dateutc": "2026-05-30T12:38:18.8177693+00:00"
},
"equipment_family_id": "c43ae09a-3daa-4fcc-bbd5-cbd62dafadfa",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "e7d1c72e-3ee5-4ab3-80b3-6e8ac43481de",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "cf8a15e1-14d5-422a-a668-ad559ae7d48a",
"_parent_code": "sample string 6",
"sales_organization_id": "2d19c777-c5b9-401b-9b38-6db319102c76",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"modified_dateutc": "2026-05-30T12:38:18.8177693+00:00"
},
"date_in_production_since": "2026-05-30T12:38:18.8177693+00:00",
"date_out_of_production_since": "2026-05-30T12:38:18.8177693+00:00",
"date_end_support": "2026-05-30T12:38:18.8177693+00:00",
"sales_organization_id": "ac5d2892-a6c2-44a6-a79b-39a421ee3a83",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+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-05-30T12:38:18.833394+00:00"
},
"project_status_id": "9a46f84c-8d12-4acf-b1f9-8f276b9a1a14",
"project_status_code": "sample string 10",
"project_status": {
"id": "06c74f9b-1aa3-43a2-bf6a-f2c3e69ffe4f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c22cd5ac-fb8e-4296-8a6a-92be076bc263",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00"
},
"company_id": "0e951e9f-d8c6-4898-a4ad-238b87ed8507",
"company_code": "sample string 12",
"db_address_id": "b0e7f80f-cd67-4ae6-ab20-feb60505a873",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0cbd362f-6ace-4f66-a2f7-88ebcd73acfb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8b5db704-4205-49f8-8e31-bd0316902c40",
"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-05-30T12:38:18.833394+00:00",
"date_create": "2026-05-30T12:38:18.833394+00:00",
"date_update": "2026-05-30T12:38:18.833394+00:00",
"updated_by_user_id": "68bfec99-7ce6-49dc-a109-7d5ccfed8c3e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-30T12:38:18.833394+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-05-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-30T12:38:18.833394+00:00",
"date_last_job": "2026-05-30T12:38:18.833394+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-30T12:38:18.833394+00:00",
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00",
"is_mobile_installation": true
},
"job_type_id": "551627d8-977c-41b6-bc48-b16ffe74ed82",
"job_type_code": "sample string 7",
"job_type": {
"id": "5ef010fb-9a9d-4077-84ba-a3051974aa21",
"name": "sample string 2",
"sales_organization_id": "5bbf9fb8-5c24-4734-8b1d-07cf3f1db26a",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00",
"code": "sample string 7"
},
"job_priority_id": "149511fa-cb7f-4438-95b2-a68fd50d769a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "54d9bcfb-5bc0-483f-aa7b-8a4faa804092",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b033bf01-45ae-4d2a-8e53-95a65422aa2f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00"
},
"job_status_id": "ed16a448-5059-449f-baa5-111214abfec4",
"job_status_code": "sample string 11",
"db_address_id": "931253e5-6b9f-43d5-a34a-ea122d7871d5",
"contact_id": "cfd4ae3e-9295-4b65-9f6e-a2e0225fc272",
"requested_by_company_id": "20ce5c16-3b3f-48d3-8724-fcc09b4ae0e7",
"requested_by_contact_id": "2b056dee-8f21-4d9d-a30c-83f7e99d1e11",
"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-05-30T12:38:18.833394+00:00",
"due_date": "2026-05-30T12:38:18.833394+00:00",
"date_create": "2026-05-30T12:38:18.833394+00:00",
"date_update": "2026-05-30T12:38:18.833394+00:00",
"date_closed": "2026-05-30T12:38:18.833394+00:00",
"suggested_user_id": "30af3dd7-d04a-4eae-ab41-b49d37e4b536",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "020587bd-cd1b-4019-a6e3-5f1b1696a88e",
"db_language_id": "d304aa10-c953-42eb-9ce6-02afca29546b",
"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-05-30T12:38:18.833394+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "63e9d0d3-239d-4cfe-bd9e-09fa96325453",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "999d612a-a840-4bf0-aca7-5b9275ac3ba9",
"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": "ccb0d056-51ee-43b0-ada6-44dd46c9ad04",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cea66f58-1dc6-44ad-bbbc-33c1eec4a99e"
},
"suggested_date_start": "2026-05-30T12:38:18.833394+00:00",
"skill_id": "567d0419-b9e7-4585-97fa-b3cc93c811cf",
"skill_code": "sample string 32",
"skill": {
"id": "6d0b0ec2-383f-4522-8665-10db41da7d9c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "59030ba5-4eaf-4a71-81bc-0c40d03f7047",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "295f2507-529c-4a12-9eda-ea7a33033792",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c56ed67e-04aa-4a88-b25f-cbdf33d8f971",
"db_currency_id": "80ff5883-6445-4241-ac42-8311cddad3ed",
"db_language_id": "a844693e-44ed-4c4b-9f08-f25c811d7b95",
"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-05-30T12:38:18.8177693+00:00"
},
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "c37d89a3-307e-454f-abb0-95a9b0f43819",
"date_reported_by_company": "2026-05-30T12:38:18.833394+00:00",
"id2": 36,
"company_id": "35bcaae0-1bbc-4e6e-bfb9-5e78d2795fd0",
"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": "5c3bc8c9-782c-45d9-8896-799f3db35e1c",
"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-05-30T12:38:18.833394+00:00"
},
"work_instruction_details_id": "f53f9af8-c3b9-4a64-9987-4ee3a95b0b65",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e1faba34-4d5f-4cea-941f-21c2bfd1a638",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "22d9527a-e638-442f-9190-81cdae17194f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-30T12:38:18.833394+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": "070648ec-f311-43e8-8e3e-b595402cacbb",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-30T12:38:18.833394+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.