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": "6f1969a2-637b-47e2-9b88-6697d00e56c8",
"jobs_id": "836e095c-4b01-45c7-9253-a41ae8969062",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "3d347fcf-9485-4c3b-958d-06faa04c581f",
"_parent_id": "43729335-7925-4e57-b92c-60dae8663be7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "55d30ca6-84fb-428b-b228-de2c1608dd2f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "24a21647-32c9-4573-bb71-2da1210b4b1b",
"_parent_id": "d20383d7-b9b6-462d-8431-636599788614",
"root_parent_id": "be4600a9-c92d-4eb7-a2b6-209ccbd4bff4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e828170f-0599-44b8-8741-9c08341f867d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "3e18f2b2-5762-4608-82c1-ced77283950c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "571f8f36-e958-4dba-bfb0-1a10c8b0d71f",
"_parent_code": "sample string 6",
"sales_organization_id": "d5bdf5ff-fbaa-408a-bf53-4f6b99412799",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"equipment_model_id": "a723b17c-4ef1-42ed-ada8-df2d06db024a",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "f5a44044-fd54-4eec-b47c-acde6e1fe7cf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4b760c13-26e8-4984-aed2-fd6028aa2fd1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "12fa717f-e5f7-47dd-9ce7-1678fd572d4b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "b1c7a579-0f41-4ac4-9998-780e1aeb60c7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"equipment_family_id": "75163006-d67c-45c1-832b-5c8c42d60359",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "3e18f2b2-5762-4608-82c1-ced77283950c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "571f8f36-e958-4dba-bfb0-1a10c8b0d71f",
"_parent_code": "sample string 6",
"sales_organization_id": "d5bdf5ff-fbaa-408a-bf53-4f6b99412799",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"date_in_production_since": "2025-11-11T22:21:25.1301912+00:00",
"date_out_of_production_since": "2025-11-11T22:21:25.1301912+00:00",
"date_end_support": "2025-11-11T22:21:25.1301912+00:00",
"sales_organization_id": "5398e5e5-9133-46b5-b957-16be40f36bf6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+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-11-11T22:21:25.1301912+00:00"
},
"project_status_id": "499ef93c-5d4b-49e2-8010-e26f511d89f3",
"project_status_code": "sample string 10",
"project_status": {
"id": "09e313c3-9b7d-4d26-aa13-a378d90b2917",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "85593cb4-a903-4bd3-b51b-8cea12fd64bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"company_id": "9b846d2c-ec7f-41d9-8e9c-5352eae5e613",
"company_code": "sample string 12",
"db_address_id": "f4d086ef-670c-45ac-bd0f-c68bdb826d80",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "97dfc322-7b8c-4099-868f-d4598f7a0ab6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3bc1ef0b-46f1-4229-ad7a-40bb8a486bcb",
"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-11-11T22:21:25.1301912+00:00",
"date_create": "2025-11-11T22:21:25.1301912+00:00",
"date_update": "2025-11-11T22:21:25.1301912+00:00",
"updated_by_user_id": "e29876f0-49e2-4c17-a965-25e197cd60b2",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-11T22:21:25.1301912+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-11-11T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-11T22:21:25.1301912+00:00",
"date_last_job": "2025-11-11T22:21:25.1301912+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-11T22:21:25.1301912+00:00",
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00",
"is_mobile_installation": true
},
"job_type_id": "71f56fca-e353-419d-9d31-07b13d72507d",
"job_type_code": "sample string 7",
"job_type": {
"id": "72ca13cd-d262-4225-8ecd-dd7bb0a9c053",
"name": "sample string 2",
"sales_organization_id": "42df700e-cf48-48b5-9dcc-84cbb84b0fd5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00",
"code": "sample string 7"
},
"job_priority_id": "76bdcf97-5e63-49d3-b5f8-d81cc1df252c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "441520b7-e7b5-43e7-b34b-5fb0fcd7c600",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9342d75c-072b-4d7b-8195-f4abfea6b618",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"job_status_id": "c4193a02-438b-4262-9cec-56f4c5071066",
"job_status_code": "sample string 11",
"db_address_id": "cc974d7e-37ec-42de-9bd5-bfe82bbe1c0f",
"contact_id": "f6df672c-3ebe-43f1-9240-e9e9a71d6d12",
"requested_by_company_id": "b4365271-0909-4454-8de1-59a41014370b",
"requested_by_contact_id": "b13cbad7-2eda-4e49-a8f8-a1b297df6ca0",
"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-11-11T22:21:25.1301912+00:00",
"due_date": "2025-11-11T22:21:25.1301912+00:00",
"date_create": "2025-11-11T22:21:25.1301912+00:00",
"date_update": "2025-11-11T22:21:25.1301912+00:00",
"date_closed": "2025-11-11T22:21:25.1301912+00:00",
"suggested_user_id": "fcda426c-b76a-48c3-aa61-96bdaa46622d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "7612ae2f-6046-465b-a692-06320a1f0e30",
"db_language_id": "a58c828c-6f3e-4e59-b66c-1c3f585a1e41",
"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-11-11T22:21:25.1301912+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f481de7f-6c26-4a30-b703-e0c12fb179b5",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c91ec509-f241-4d75-8261-171b3673771a",
"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": "c575e5fb-9105-4f85-b677-2c79c8671f95",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5083b0f2-371a-4d0e-9b10-0b6069386d9a"
},
"suggested_date_start": "2025-11-11T22:21:25.1301912+00:00",
"skill_id": "231987ae-c3ec-4caa-9ec8-3a53517455df",
"skill_code": "sample string 32",
"skill": {
"id": "a991b250-e474-4f2d-b6b8-de82bbfdedeb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d5a90470-02be-41fd-9a30-f9e3214865f3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3de32209-920a-473d-8d29-d5e9f559e238",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "aa0289c0-e335-482e-a465-acfca77ef7c8",
"db_currency_id": "5e4dd9f3-3653-4a73-a136-77403f89be8d",
"db_language_id": "bcc19b31-6c6d-438d-86ec-d3b37a986909",
"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-11-11T22:21:25.1301912+00:00"
},
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ce6bbac4-471c-41f9-a659-eb68fc3c8f93",
"date_reported_by_company": "2025-11-11T22:21:25.1301912+00:00",
"id2": 36,
"company_id": "39e8cd0d-4861-42f6-92ca-057a7fdf1235",
"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": "fe02f236-cafc-49e0-9f2a-57d0c0bdebd0",
"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-11-11T22:21:25.1301912+00:00"
},
"work_instruction_details_id": "5d23d7eb-bbaf-4218-bbc8-67125d9f72fc",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "c82857b9-dc93-4749-a31e-fd99fefa543e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f4876545-3cc1-4942-8e56-6ee599d01a1d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-11T22:21:25.1301912+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": "e3a42d0f-4431-4dc6-a150-9c65140069f4",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-11T22:21:25.1301912+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.