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": "804dc954-e44d-4a8b-96d0-56e69caca1f4",
"jobs_id": "a13c45a6-df5b-4d30-9e99-f26e2ee04d6f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "66d3aaf7-9bee-41d7-9bbb-0b22f6c4c4cf",
"_parent_id": "9875f182-e145-4f56-ada8-5b71c2393adb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3353bcc2-8dce-4887-afb2-dad9a892e7ac",
"project_reference_back_office": "sample string 5",
"project": {
"id": "036ae153-c98e-494e-a4f8-9498c3b42233",
"_parent_id": "5d75491f-a103-444f-bebe-39f89d2ffff3",
"root_parent_id": "4610653d-3039-4c90-8745-7d1664c441b6",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "94a53678-d051-4226-a55a-942549c0019b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "a4b992ff-6143-4da2-9a0b-c019b04cf7f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43f17b34-6ce7-433c-aca0-d48a3bd9218b",
"_parent_code": "sample string 6",
"sales_organization_id": "10a9c324-9f03-4979-a62b-a2f0feeff62e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"equipment_model_id": "99c19d3a-9716-4fd9-a1c8-6ffa65ab1047",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "236ce67f-906f-4e2e-bf7a-07f5c32d58f4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "224fc377-7fbe-43db-a5ba-722c25f6b492",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0cc9178e-8ad8-4beb-9527-a1a6e7f0d3e2",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "be582a80-ed3a-4129-8170-42e3145000cd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"equipment_family_id": "9a528a2c-cc67-4edf-b7c5-32fcd3f19de1",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "a4b992ff-6143-4da2-9a0b-c019b04cf7f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "43f17b34-6ce7-433c-aca0-d48a3bd9218b",
"_parent_code": "sample string 6",
"sales_organization_id": "10a9c324-9f03-4979-a62b-a2f0feeff62e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"date_in_production_since": "2026-06-08T15:08:36.8648564+00:00",
"date_out_of_production_since": "2026-06-08T15:08:36.8648564+00:00",
"date_end_support": "2026-06-08T15:08:36.8648564+00:00",
"sales_organization_id": "06f7d65a-0e36-4659-9f26-7ca160cc6e26",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+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-06-08T15:08:36.8648564+00:00"
},
"project_status_id": "b3d54607-7d41-4cc7-8985-3cf70f1ac0fb",
"project_status_code": "sample string 10",
"project_status": {
"id": "e9e56808-42c1-4a4c-85d7-e58a52f36cc1",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "abb2592d-bbb1-4a84-82bc-c6e344ebe9a0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"company_id": "51c1ceae-0474-4595-a707-8bfec39c4a46",
"company_code": "sample string 12",
"db_address_id": "64ed0c6a-4714-46fb-bb6d-73f66a5288cc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5c77aa0b-b46d-472b-b1ac-9f36c9fa41c1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7c687813-92fd-4cf0-a9bf-1ac93817b7d8",
"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-06-08T15:08:36.8648564+00:00",
"date_create": "2026-06-08T15:08:36.8648564+00:00",
"date_update": "2026-06-08T15:08:36.8648564+00:00",
"updated_by_user_id": "27b050e6-f9db-4a20-adab-8b9427cd6b60",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-06-08T15:08:36.8648564+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-06-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-06-08T15:08:36.8648564+00:00",
"date_last_job": "2026-06-08T15:08:36.8648564+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-06-08T15:08:36.8648564+00:00",
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00",
"is_mobile_installation": true
},
"job_type_id": "30d64fae-582d-45cf-a922-60f21c3e40b5",
"job_type_code": "sample string 7",
"job_type": {
"id": "be78b3c2-eb14-4266-b9b5-18e66afb485c",
"name": "sample string 2",
"sales_organization_id": "a1a726ed-e581-4688-81b2-76aa92040ed4",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00",
"code": "sample string 7"
},
"job_priority_id": "dca250da-efd9-40b1-af52-8c4177f7890e",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "bd0f9eca-03c3-429a-aa26-c72b56732880",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "8f3768e6-2601-499d-a7d4-6891776064a3",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"job_status_id": "d437ec4d-be40-4a85-a0a5-7f25bc9043b8",
"job_status_code": "sample string 11",
"db_address_id": "8e1c8bcd-474e-48b5-88ea-c7fe1c6d9cc1",
"contact_id": "e7aea5ca-9155-4960-8a41-955c0c1886bc",
"requested_by_company_id": "5afac600-8734-47ca-9e96-844ac973ae2a",
"requested_by_contact_id": "3017753d-fa62-478a-8fbd-50013b99808d",
"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-06-08T15:08:36.8648564+00:00",
"due_date": "2026-06-08T15:08:36.8648564+00:00",
"date_create": "2026-06-08T15:08:36.8648564+00:00",
"date_update": "2026-06-08T15:08:36.8648564+00:00",
"date_closed": "2026-06-08T15:08:36.8648564+00:00",
"suggested_user_id": "4e8eca77-a45a-425d-b73a-d92ad7897918",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fa49a32c-382a-4b59-838c-89ea313a7d97",
"db_language_id": "ab63b998-39a4-472d-8ceb-5dd1caf89ab1",
"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-06-08T15:08:36.8648564+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "241946f1-b8b0-4444-88ff-7ee9ee66563a",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "732b278b-79fc-4e52-8760-d4af3dea6fdb",
"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": "79f6cfa8-c3d8-4307-bc77-0d23994d3c98",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "79a1c503-c56c-4d41-a539-874ee227bb73"
},
"suggested_date_start": "2026-06-08T15:08:36.8648564+00:00",
"skill_id": "1df5e81c-568c-447d-ac2a-310a6a213248",
"skill_code": "sample string 32",
"skill": {
"id": "cd667a1b-0da7-4228-87e9-012a50472cf9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "dec3292d-513a-4826-b76f-d8747d99d6ab",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f8275440-1b72-4808-b78f-c07beffd725e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f15c2447-cf80-4014-8e67-b9fbe117b941",
"db_currency_id": "f54f3e6c-9374-4796-8d94-91a54a316d25",
"db_language_id": "93763cdf-6ade-4be0-bfdc-623bce5ea501",
"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-06-08T15:08:36.8492312+00:00"
},
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ef6ef9b1-ffdf-499c-96f1-52b4d5eeb804",
"date_reported_by_company": "2026-06-08T15:08:36.8648564+00:00",
"id2": 36,
"company_id": "8922dba5-4009-4efa-9c3c-23ccf578e69e",
"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": "3e1b053f-2d61-4316-8e2d-ee6eb860b0c9",
"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-06-08T15:08:36.8648564+00:00"
},
"work_instruction_details_id": "89d6f3c3-a654-42bc-a5a2-95957ec67159",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2e0b15f1-baed-4832-b4bf-7de8abb6abf9",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "36910669-ea3d-4c11-ad25-ca7cd6986856",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-06-08T15:08:36.8648564+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": "98bc9778-6be5-4b1d-bdcf-3dff5a7819bc",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-06-08T15:08:36.8648564+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.