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": "05e18587-2b84-4f4a-bffa-dd3292e34ebe",
"jobs_id": "e170ec0d-95a3-412c-9c8d-986b28cb0b79",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3163c95a-5f6d-4e78-ba05-d50659d467be",
"_parent_id": "1e753b79-db4f-475d-9cff-5e7fc63be1d8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4c06cba4-37fa-4400-9514-f0542e40e3d8",
"project_reference_back_office": "sample string 5",
"project": {
"id": "a4a41fd7-085f-40ac-90f5-65a19d9cc362",
"_parent_id": "47a960a0-d1ae-4885-bd63-7dff2d1ee3d1",
"root_parent_id": "9522b0c3-2415-41f5-943d-4824271eabda",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "65410677-545b-4daa-bd00-c672142f0115",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a99b6b0a-f489-449c-8ded-5c4a5d49b06d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "20db06aa-b071-4730-b04c-5be4a5da8410",
"_parent_code": "sample string 6",
"sales_organization_id": "5c88028f-8db8-40cf-b090-1d6473939582",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"equipment_model_id": "ed6a20bd-58b7-46f1-9a1b-6be63e95d97b",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "da277032-f2b8-47d5-9222-61294654922e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "075e66b3-02de-4131-94c5-9dc1c8fa23de",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d783641f-09a3-47d2-8230-b69bb29efd28",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "da92f95c-9b7d-4b08-98c6-2930cb079dd0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"equipment_family_id": "903e9392-4d27-4fd9-b876-60f0d0c902c0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a99b6b0a-f489-449c-8ded-5c4a5d49b06d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "20db06aa-b071-4730-b04c-5be4a5da8410",
"_parent_code": "sample string 6",
"sales_organization_id": "5c88028f-8db8-40cf-b090-1d6473939582",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"date_in_production_since": "2026-10-08T15:53:25.3401206+00:00",
"date_out_of_production_since": "2026-10-08T15:53:25.3401206+00:00",
"date_end_support": "2026-10-08T15:53:25.3401206+00:00",
"sales_organization_id": "3f67c6b0-7abe-4ad8-a4f6-6f2bef3104f9",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+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-08T15:53:25.3401206+00:00"
},
"project_status_id": "9e474025-fb46-4c59-bb9d-1196140e5f2c",
"project_status_code": "sample string 10",
"project_status": {
"id": "8062ff72-d2d0-4883-8fed-f30c0af5e2c4",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "144df29d-7ead-425f-8c0b-be1f6120810a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"company_id": "cd58954a-42c0-4607-b6dd-8bed4dc606d6",
"company_code": "sample string 12",
"db_address_id": "4328c6c5-06c9-4b50-8921-08d579ad2a0c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "3a793699-7dd5-47ba-983a-2e6b756f864c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f7c1cc41-eef6-400c-beb8-bf7d22fb0ab4",
"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-08T15:53:25.3401206+00:00",
"date_create": "2026-10-08T15:53:25.3401206+00:00",
"date_update": "2026-10-08T15:53:25.3401206+00:00",
"updated_by_user_id": "5095b80e-f1f0-4553-a71d-708b947a4811",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-08T15:53:25.3401206+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-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-08T15:53:25.3401206+00:00",
"date_last_job": "2026-10-08T15:53:25.3401206+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-08T15:53:25.3401206+00:00",
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00",
"is_mobile_installation": true
},
"job_type_id": "3a7e902f-90c4-4320-bdb1-0ed7a6b090f9",
"job_type_code": "sample string 7",
"job_type": {
"id": "3e77c969-1762-40f3-a755-83adcd0d5415",
"name": "sample string 2",
"sales_organization_id": "49e509b5-d056-40f0-8b75-bcac3ecaceb6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00",
"code": "sample string 7"
},
"job_priority_id": "71bec93c-7ec5-4e28-a032-eae37859b3cf",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ca838dea-44da-4f7d-9768-3d2fb13cd391",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dd3731bb-6cab-4215-8927-ae83f0e18671",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"job_status_id": "b8402191-2d4e-402b-b071-36e72911b770",
"job_status_code": "sample string 11",
"db_address_id": "bae5ed97-ff4d-451d-8d11-39414aea164d",
"contact_id": "963f03a2-51df-4492-9b44-1d1d3c764aba",
"requested_by_company_id": "078cd846-e5a5-4f8e-9ab7-1dfbd32c4c0e",
"requested_by_contact_id": "01ff5809-3e00-4013-b6d1-a013af0c1ca4",
"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-08T15:53:25.3401206+00:00",
"due_date": "2026-10-08T15:53:25.3401206+00:00",
"date_create": "2026-10-08T15:53:25.3401206+00:00",
"date_update": "2026-10-08T15:53:25.3401206+00:00",
"date_closed": "2026-10-08T15:53:25.3401206+00:00",
"suggested_user_id": "11fc0c1d-cd5c-461f-98a3-6ccf878d8d52",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7ca544a2-a59e-41cd-95b4-eef56dc686e5",
"db_language_id": "25d61807-78bf-4d0e-b801-82313e44de3f",
"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-08T15:53:25.3401206+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f5e98bcd-9c9b-4d4f-a0b7-164182d30e8b",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1c9d00f8-63bd-4237-b78f-51c2925635dc",
"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": "41b2f875-0beb-47be-ab60-1ec38ebd489d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "c9a1375f-b373-41a7-bdf9-03fcc2704305"
},
"suggested_date_start": "2026-10-08T15:53:25.3401206+00:00",
"skill_id": "8cd0aa3f-32df-42b9-a527-bbe55bfb9979",
"skill_code": "sample string 32",
"skill": {
"id": "af0f5684-c7ea-44cd-b379-63d3260c2805",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "70f9feda-01cd-4707-9935-5c78555cad41",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a2387de4-6cd7-4215-bfad-3a182dc6d0d1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "108903fa-a1e7-4097-be39-147583e0f57c",
"db_currency_id": "113f8e35-1616-4505-ac5f-9359c819da29",
"db_language_id": "12e355bc-8756-450d-a986-0f3aadea4e7e",
"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-08T15:53:25.3401206+00:00"
},
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "34d16c20-8db8-4cf7-be08-c98ecd36975a",
"date_reported_by_company": "2026-10-08T15:53:25.3401206+00:00",
"id2": 36,
"company_id": "8ce91a88-182f-47cb-968e-db3fb0902115",
"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": "e72b6837-1b8f-471f-b844-46e477f57caf",
"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-08T15:53:25.3401206+00:00"
},
"work_instruction_details_id": "5cc67de2-9838-4d40-b52d-6f06d9de9597",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "696a06bc-7a53-47a8-8fb4-061b0cc6558c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "58388898-ebca-423b-8b39-b2756b177656",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-08T15:53:25.3401206+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": "2128f938-85b1-4637-a9ff-58bbb4fde2da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-08T15:53:25.3401206+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.