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": "6061d527-ab54-4323-b014-5b6ff2c1405b",
"jobs_id": "57da681f-9774-448d-98b9-2869bcb0c0de",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "99d27835-a9f8-4a57-b725-ece2bd46636c",
"_parent_id": "1b423b0a-29e4-4cb8-89c3-9ea7b810b130",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21841c84-98e3-4688-995b-39a8eeee6c0f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "6b4f4b6a-633c-4db5-b8cc-555b4fe6920c",
"_parent_id": "34211e3a-83fa-4805-a5fc-1d6a2df3f07a",
"root_parent_id": "e2fd8f7e-827e-44b5-aab9-b8efcf4d8263",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b99f2266-7ed3-4156-809e-83fbc5116c3a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9cc2d240-a3cf-4a61-b4db-793526302814",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "30338f78-6133-4b1c-b179-aadf87573dd1",
"_parent_code": "sample string 6",
"sales_organization_id": "7d493c0e-2554-44db-b0aa-686075c3eaac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"equipment_model_id": "6409a624-8953-4492-9709-1e958a8c274e",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "095838aa-7464-45cb-b051-0fd7b7c0dc5a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "354edd01-1b5a-423d-894b-16cc493e5fd9",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b0e1eaa8-2ff4-4a10-9041-b6d96cb88da3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8f28c094-0b7f-41d4-99c3-38c26846bd26",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"equipment_family_id": "a8f810b2-4966-41c6-910e-2c0272f1f92f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9cc2d240-a3cf-4a61-b4db-793526302814",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "30338f78-6133-4b1c-b179-aadf87573dd1",
"_parent_code": "sample string 6",
"sales_organization_id": "7d493c0e-2554-44db-b0aa-686075c3eaac",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"date_in_production_since": "2026-11-08T16:14:42.9770232+00:00",
"date_out_of_production_since": "2026-11-08T16:14:42.9770232+00:00",
"date_end_support": "2026-11-08T16:14:42.9770232+00:00",
"sales_organization_id": "81ec74ad-bb20-401e-8ffd-88b3198bc9a0",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+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-11-08T16:14:42.9770232+00:00"
},
"project_status_id": "a0cc002a-ac17-46b3-a036-94f0eb44d29c",
"project_status_code": "sample string 10",
"project_status": {
"id": "73e5d193-9bb8-4c69-a942-11a0c0e0ba77",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "369dd605-cd9c-43a4-ac31-4c8f91556a3b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"company_id": "e700c2d3-6920-461e-b56d-1eb08d25cb9b",
"company_code": "sample string 12",
"db_address_id": "c364b25b-09bf-44fc-bb22-905737d64418",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "7a168114-04d0-4154-a06d-ba390b2dadcc",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "74176cda-0330-4a3b-9f8b-2e72e9678251",
"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-11-08T16:14:42.9770232+00:00",
"date_create": "2026-11-08T16:14:42.9770232+00:00",
"date_update": "2026-11-08T16:14:42.9770232+00:00",
"updated_by_user_id": "3220d3e2-c10f-47c3-9861-513cbcf31140",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-08T16:14:42.9770232+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-11-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-08T16:14:42.9770232+00:00",
"date_last_job": "2026-11-08T16:14:42.9770232+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-08T16:14:42.9770232+00:00",
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00",
"is_mobile_installation": true
},
"job_type_id": "62982a05-1243-4259-afce-6011b5ee34ca",
"job_type_code": "sample string 7",
"job_type": {
"id": "ac528761-467f-43d3-ad2d-cf82c5405235",
"name": "sample string 2",
"sales_organization_id": "c70543b1-636a-410e-be10-7a199f5eed9f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00",
"code": "sample string 7"
},
"job_priority_id": "80e57768-a4d0-4479-85ea-c4ffe5db08ec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "66c2f5de-b8df-4219-901c-a254ac5459c6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9986a96d-ad3e-4cbf-8ea5-a21534895835",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"job_status_id": "4aef510c-7bd4-4da6-9dcd-638f82f17a0d",
"job_status_code": "sample string 11",
"db_address_id": "608ed49a-e3e8-4c7b-8c00-46e39a84db8d",
"contact_id": "70ee5043-fd70-46a9-bbeb-e9fd3313abb4",
"requested_by_company_id": "9e74922f-4fd7-46b5-9b3a-672abd85b6bc",
"requested_by_contact_id": "adac9121-b843-479f-8e45-d3e4af220d97",
"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-11-08T16:14:42.9770232+00:00",
"due_date": "2026-11-08T16:14:42.9770232+00:00",
"date_create": "2026-11-08T16:14:42.9770232+00:00",
"date_update": "2026-11-08T16:14:42.9770232+00:00",
"date_closed": "2026-11-08T16:14:42.9770232+00:00",
"suggested_user_id": "0c170300-f79f-49fa-aabb-ddafcd01002f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ed23c524-2d39-4897-900f-be4839c067a8",
"db_language_id": "d7ca065b-9c22-4590-88c3-57d7c70c2183",
"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-11-08T16:14:42.9770232+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "15fa2759-0916-4358-8e04-7c33ade3abbd",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6292de22-0312-430b-ba8e-e8760081b8b0",
"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": "b423ff6a-dc76-4098-b766-be1d5a8eeedf",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "dce842cf-effa-44f5-a965-051b819d9a42"
},
"suggested_date_start": "2026-11-08T16:14:42.9770232+00:00",
"skill_id": "84b5e226-8285-4981-bf24-4b963b824a92",
"skill_code": "sample string 32",
"skill": {
"id": "edbb6f18-8305-4cdb-ad2a-fbccde9c903f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5294e24d-59c9-4641-8073-c6dea751aa11",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3641c5f6-fb7d-4a42-a706-d9ff29169bdc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "bab7b353-477c-4f87-a68b-1a426c2b1b48",
"db_currency_id": "0ac50b90-86a3-4460-9771-bc206622020d",
"db_language_id": "502d1366-8517-42b4-b61c-cb1d765eca27",
"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-11-08T16:14:42.9770232+00:00"
},
"modified_dateutc": "2026-11-08T16:14:42.9770232+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f889977b-cd41-490c-8119-a394bf1a9307",
"date_reported_by_company": "2026-11-08T16:14:42.9770232+00:00",
"id2": 36,
"company_id": "85fa728f-0534-4d1b-a7ef-02e39492baf0",
"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": "e7749fdb-d1d1-4950-8c70-f796a9b426f5",
"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-11-08T16:14:42.9940789+00:00"
},
"work_instruction_details_id": "f8830679-14b1-42cb-ba65-20b2438d0176",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b2b8bdcf-e118-4f5a-8246-a54543f4781e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "54ca362b-5a52-4882-8508-92638f91b056",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-08T16:14:42.9940789+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": "f9aaf280-537d-4dc4-8405-c1fb697af262",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-08T16:14:42.9940789+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.