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": "7e5c3f7c-e8d2-494b-82f7-531e04a40ed9",
"jobs_id": "6d539e10-9087-4ad6-9a2e-41c6dd6ed366",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4795f3b6-4ec4-4c75-b41f-268eb80d3f61",
"_parent_id": "d446da0a-798e-434f-9429-875bfe51569a",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "800594d2-584f-4a08-98a9-26c5788ca03e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "fa42c931-5645-4fd3-ac6a-4a9c623953d4",
"_parent_id": "94b427b2-e6e0-4235-bc41-08bcd65df8e3",
"root_parent_id": "277380bf-ea0f-4e27-8e14-764c5bf0c2aa",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "2f93b32c-77c1-409b-ab75-d4c674390c28",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "9ee8e75c-df28-4eb0-a0ac-d9ffec7c999e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afff7cde-72d1-427b-b091-4050b126ae31",
"_parent_code": "sample string 6",
"sales_organization_id": "c4a5a9e1-637c-49e1-83f1-b0c3dbb5b057",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"modified_dateutc": "2025-10-04T01:58:12.7988094+00:00"
},
"equipment_model_id": "6ae3d040-d064-4ed9-b69e-9742700a42ee",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "732004ab-629e-4761-a2e7-ab019d0301c8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "9de4f075-1cb1-4eb7-8f0c-5e2792570c07",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "d426366b-a7e8-4db3-aca1-b6436f3923c3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e6608d64-04fb-433a-8127-12991fb017fd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"modified_dateutc": "2025-10-04T01:58:12.7988094+00:00"
},
"equipment_family_id": "90fdd28a-4458-4069-88d4-f29dc56fa4cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "9ee8e75c-df28-4eb0-a0ac-d9ffec7c999e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "afff7cde-72d1-427b-b091-4050b126ae31",
"_parent_code": "sample string 6",
"sales_organization_id": "c4a5a9e1-637c-49e1-83f1-b0c3dbb5b057",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"modified_dateutc": "2025-10-04T01:58:12.7988094+00:00"
},
"date_in_production_since": "2025-10-04T01:58:12.7988094+00:00",
"date_out_of_production_since": "2025-10-04T01:58:12.7988094+00:00",
"date_end_support": "2025-10-04T01:58:12.7988094+00:00",
"sales_organization_id": "5ef9ddeb-4066-4228-8306-1f2d2990d89e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+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": "2025-10-04T01:58:12.8144343+00:00"
},
"project_status_id": "04599699-d79b-4217-be4a-fa7b2151153d",
"project_status_code": "sample string 10",
"project_status": {
"id": "30b9d3a2-d6b2-460e-a160-aa6cdb5612c7",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "a1b40a88-83d8-4b65-b637-61dde2fd67b7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00"
},
"company_id": "abb1338a-4e8b-414a-8125-d3b5a8d3e8f8",
"company_code": "sample string 12",
"db_address_id": "05a78081-0e3b-48bf-a7eb-29af0c1dd3fa",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "db0371ff-44cd-4aaa-a7ff-f01298fb685f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "120875bf-997c-4264-91d9-923a4b688318",
"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": "2025-10-04T01:58:12.8144343+00:00",
"date_create": "2025-10-04T01:58:12.8144343+00:00",
"date_update": "2025-10-04T01:58:12.8144343+00:00",
"updated_by_user_id": "df455bfb-5ebf-41a8-b217-0e7eacbc9bc4",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-04T01:58:12.8144343+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": "2025-10-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-04T01:58:12.8144343+00:00",
"date_last_job": "2025-10-04T01:58:12.8144343+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-04T01:58:12.8144343+00:00",
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00",
"is_mobile_installation": true
},
"job_type_id": "aa9816a7-876f-408e-aaf8-2be33686dceb",
"job_type_code": "sample string 7",
"job_type": {
"id": "88b49520-15fd-441e-a904-674def9313a3",
"name": "sample string 2",
"sales_organization_id": "4a7bd354-ed52-4353-9741-125115fb47ff",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00",
"code": "sample string 7"
},
"job_priority_id": "925710f9-32e0-4ff6-b489-14b14ecd7eec",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2c74c14e-88e4-4343-9332-1a41f7141e56",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b4ea7eb3-bafd-47e3-93c7-ef729db15ed1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00"
},
"job_status_id": "4d829c96-8c08-47e1-900a-2b4dcd6da05f",
"job_status_code": "sample string 11",
"db_address_id": "7c83fcd4-e081-4c19-879c-0bc89d8f6bce",
"contact_id": "4fe73df4-9ace-4e91-a845-c08bf8242001",
"requested_by_company_id": "7f44ba8c-1e21-4747-9b91-2feda7f76a4a",
"requested_by_contact_id": "2e4c5266-7036-4eac-82b1-a8b1fcda9d00",
"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": "2025-10-04T01:58:12.8144343+00:00",
"due_date": "2025-10-04T01:58:12.8144343+00:00",
"date_create": "2025-10-04T01:58:12.8144343+00:00",
"date_update": "2025-10-04T01:58:12.8144343+00:00",
"date_closed": "2025-10-04T01:58:12.8144343+00:00",
"suggested_user_id": "20c5efd9-5f9c-49ac-8059-b407e2bd94f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "0a668aa1-c7d1-4487-b259-c0c6c3975dbe",
"db_language_id": "1c9aebb5-b256-488b-88f6-f629c655082c",
"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": "2025-10-04T01:58:12.8144343+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f0f13add-dc48-4ad4-b197-491ec494b0d8",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "1e737879-1317-46c8-9f8b-2d3ff783fd2c",
"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": "1d7b2efc-1511-4ef5-9dce-b579e71ce7ef",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "fa15b1af-6314-4fa9-af51-667877eabc84"
},
"suggested_date_start": "2025-10-04T01:58:12.8144343+00:00",
"skill_id": "c090336f-8d68-469b-801c-dc5dfb55f813",
"skill_code": "sample string 32",
"skill": {
"id": "d565de6d-62b8-4616-9f0f-e877a3e18f25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "55ed0a68-e363-4c7c-8473-850a8f5ae5f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e51f0c8c-7b5f-4208-82ec-85b3359a754a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "d6c32ce4-df77-4bf5-bf5b-8527566fed3e",
"db_currency_id": "29c114ef-1407-4d06-ba78-9ea910393923",
"db_language_id": "8b81adad-13ac-4080-8b41-a551bc27aa3a",
"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": "2025-10-04T01:58:12.7988094+00:00"
},
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4d216a43-a2e6-4316-a752-5350d2e46891",
"date_reported_by_company": "2025-10-04T01:58:12.8144343+00:00",
"id2": 36,
"company_id": "bfa40827-1ea3-4395-99b5-9d23907664cb",
"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": "8c431074-00fb-42b4-9e9f-db4c18b0d75d",
"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": "2025-10-04T01:58:12.8144343+00:00"
},
"work_instruction_details_id": "718703f1-17e6-425e-9e4c-fac5ea8d8af7",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "9ca3fbce-2d92-4d81-8866-40175e1fb3bf",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "51c2a8cb-90f5-4679-b7c3-f8dc871c990a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-04T01:58:12.8144343+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": "7e889959-5323-4279-a2bb-5f94fa3e9e43",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-04T01:58:12.8144343+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.