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": "d5ab5aec-4c2a-4e6e-b496-f84707c0a075",
"jobs_id": "c6107e48-c13f-4d96-9bf1-7f5e20f1e47c",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8721aa41-b7ad-484f-8a3b-5c04065166a0",
"_parent_id": "f2cfd490-9b0a-4ac1-9676-54e074b15f22",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d2343129-4980-4c4e-a0e2-a50f691be72a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e1acd084-7f67-4904-bf3f-0c97ea01c0f7",
"_parent_id": "9464e404-7c58-4aa9-9826-40a868d1f079",
"root_parent_id": "ec539071-3060-456a-9ae7-a305d9a375ab",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ff33a1f4-0aaa-4315-b718-9a237b517487",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ec95538-e052-4df2-8f00-cd49b526bfb2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ec53d940-9c5f-433c-ab42-bdac6171f162",
"_parent_code": "sample string 6",
"sales_organization_id": "085d1f0f-4a6a-4e9e-a571-a85bf540396b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"equipment_model_id": "e2c1518f-af24-493e-858e-38dbd3fc474b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a4dd9b2c-6232-40a6-be4e-91de6ea7a6cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1cf816e0-41a3-4a75-8146-8161b47be247",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1e7dc7bc-a0ed-45ae-8914-dc30399e7f39",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f9f33923-d3c7-4055-9ee1-43d24acdb2a1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"equipment_family_id": "be3bfaad-fed3-42b9-9a4a-fe4a0f96b669",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ec95538-e052-4df2-8f00-cd49b526bfb2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "ec53d940-9c5f-433c-ab42-bdac6171f162",
"_parent_code": "sample string 6",
"sales_organization_id": "085d1f0f-4a6a-4e9e-a571-a85bf540396b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"date_in_production_since": "2026-03-12T02:58:20.3450241+00:00",
"date_out_of_production_since": "2026-03-12T02:58:20.3450241+00:00",
"date_end_support": "2026-03-12T02:58:20.3450241+00:00",
"sales_organization_id": "986b9814-a242-4a0d-bd1a-03c42f8a3cdf",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+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-03-12T02:58:20.3450241+00:00"
},
"project_status_id": "32a437cd-f6a7-4263-9691-5819f018c25a",
"project_status_code": "sample string 10",
"project_status": {
"id": "dd2c5ed6-1c2c-4565-89b9-aadb83eb739b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "26f30520-07e4-45db-a2ee-951dbf0c6598",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"company_id": "ad9808ac-5cc5-47d9-a46a-0bb6c3d373e7",
"company_code": "sample string 12",
"db_address_id": "ea47cfc4-4b44-4902-87db-b9560f4881f8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "81125889-435f-400c-a9bd-cfc9ae6eabf4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b98386d2-b743-40fc-b416-446efac2f5d1",
"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-03-12T02:58:20.3450241+00:00",
"date_create": "2026-03-12T02:58:20.3450241+00:00",
"date_update": "2026-03-12T02:58:20.3450241+00:00",
"updated_by_user_id": "72d46717-6cb1-4c7e-ae5b-7efdc5b93f14",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-03-12T02:58:20.3450241+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-03-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-03-12T02:58:20.3450241+00:00",
"date_last_job": "2026-03-12T02:58:20.3450241+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-03-12T02:58:20.3450241+00:00",
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00",
"is_mobile_installation": true
},
"job_type_id": "a251cd47-39c6-4a1f-aafb-29441f562a15",
"job_type_code": "sample string 7",
"job_type": {
"id": "9d9709f8-d996-45aa-bac4-edeb71e26862",
"name": "sample string 2",
"sales_organization_id": "c1561a5e-ac9c-46a0-9108-17e1240046af",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00",
"code": "sample string 7"
},
"job_priority_id": "bc64d4f4-5390-4dc4-bf65-5149659bd5b7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "df37208f-b848-4bd3-a03a-e6a4d784a640",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4234c5db-6e97-4cd8-a2e6-98ab92e24473",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"job_status_id": "18f1885e-359a-4635-9744-d1df9c9e394b",
"job_status_code": "sample string 11",
"db_address_id": "e9f39e7a-fd3e-467e-afb4-5e1b25415de7",
"contact_id": "e55b7ecb-fcf5-44bf-b596-8a82a47e1754",
"requested_by_company_id": "6b195675-e230-493f-94c0-c61cf950bcda",
"requested_by_contact_id": "2473728c-050e-475f-8d0f-345595fa5975",
"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-03-12T02:58:20.3450241+00:00",
"due_date": "2026-03-12T02:58:20.3450241+00:00",
"date_create": "2026-03-12T02:58:20.3450241+00:00",
"date_update": "2026-03-12T02:58:20.3450241+00:00",
"date_closed": "2026-03-12T02:58:20.3450241+00:00",
"suggested_user_id": "70359798-abd9-4713-9800-26521c556207",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "9706fcb4-6642-412a-a11b-f93f66d3adaa",
"db_language_id": "14863f4e-6341-4e46-8ca5-1cc40a1b8be2",
"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-03-12T02:58:20.3450241+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "46b205c0-6d3c-43e1-b86a-55fd68a80fab",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc8cd582-5ac7-431a-9548-937b45f30026",
"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": "a03be249-c26c-4780-8407-5f01873fe291",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d8605169-67f4-4f50-bc97-ee963bb9906b"
},
"suggested_date_start": "2026-03-12T02:58:20.3450241+00:00",
"skill_id": "2a1b697c-96ab-484f-b28f-efb18b7eca75",
"skill_code": "sample string 32",
"skill": {
"id": "048d700a-10b0-46f2-a43f-756551ff5334",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b178100c-fd1e-4338-adc1-029e3ff90e68",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2419c56b-ecc7-4194-90a6-0c43add24deb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "009a2a1f-7fe5-4a15-bd20-e51256a76e80",
"db_currency_id": "e7be7921-765d-4277-8da5-3711f852c1e4",
"db_language_id": "9e1ef816-d1b3-4112-a27b-fd996692bc02",
"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-03-12T02:58:20.3450241+00:00"
},
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "456890b7-1d03-41a3-a1a8-1ddb09cac50a",
"date_reported_by_company": "2026-03-12T02:58:20.3450241+00:00",
"id2": 36,
"company_id": "fc0cd44e-0d3d-4998-bcb7-6db8edc7a1f5",
"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": "a08fc083-8de8-44a0-a999-9b838a879c46",
"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-03-12T02:58:20.3450241+00:00"
},
"work_instruction_details_id": "9ab13df0-0f5e-407a-a2a4-ef83ca5bd635",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8bf0374a-0f69-4732-9a50-51ac69f36ac0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c6dab8a0-feaa-4ea1-99e7-f4baa70d03c3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-03-12T02:58:20.3450241+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": "493d0986-8074-46d4-beae-2281e168a602",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-03-12T02:58:20.3450241+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.