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": "b493290d-9b7e-471b-a99d-b27f1857724c",
"jobs_id": "10836f5d-940f-4b7f-8e5f-b56b700209f9",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4db379b9-4b6c-493d-bc89-89da3e053a22",
"_parent_id": "b7aa2b94-f3fc-4773-b19c-3babdde37a6c",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "be7e98cf-5d5d-4d1c-b1ea-6cee1587bb42",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0bd1bda5-eb92-4e3e-889e-2b2a45ac921c",
"_parent_id": "ce6ee718-71da-4bb8-aaf6-ac22662bbc3a",
"root_parent_id": "fb876e38-4f61-4a59-a3ec-4e7f4bfd81ee",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "947a1a41-986b-4263-9390-64074e04f1dd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "844e35cb-99a0-49d8-8d4f-89a1e05d7828",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "70b270ed-76cb-42ef-bc2b-f0e6d48b3563",
"_parent_code": "sample string 6",
"sales_organization_id": "b7a937d2-e564-4b88-9f02-233f476ea076",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"equipment_model_id": "156be4ec-29c1-4894-8ca8-0d988b4c7724",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "cbaf300e-50ea-4565-8e6c-8a58387295c4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "3d8ce4cd-361a-4690-bdd3-45693f9b14ba",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "0b75d4c3-1ae3-4d85-a1f7-e04ef698e001",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f80a46e1-273c-4dc7-b286-9a37484df7b5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"equipment_family_id": "ece98b91-3ae4-45d5-bd2f-06e1f32f2a9e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "844e35cb-99a0-49d8-8d4f-89a1e05d7828",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "70b270ed-76cb-42ef-bc2b-f0e6d48b3563",
"_parent_code": "sample string 6",
"sales_organization_id": "b7a937d2-e564-4b88-9f02-233f476ea076",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"date_in_production_since": "2026-07-05T22:16:41.9609575+00:00",
"date_out_of_production_since": "2026-07-05T22:16:41.9609575+00:00",
"date_end_support": "2026-07-05T22:16:41.9609575+00:00",
"sales_organization_id": "f33af369-dd9d-4a04-8a90-f8f11db6347e",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+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-07-05T22:16:41.9609575+00:00"
},
"project_status_id": "c3dbabfb-385a-4213-8b04-2466b3e4d271",
"project_status_code": "sample string 10",
"project_status": {
"id": "f6c87fa3-ff3c-4546-8d28-96d50fab5dce",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "30e5f550-fc44-4dfc-b4bd-f2b00a82a55c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"company_id": "c6aef9b3-c2bc-4d40-b02a-0b0d591167d5",
"company_code": "sample string 12",
"db_address_id": "ec9c9c1b-5373-43e8-9409-106f5982e3d7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "94e137d7-d970-42b2-b225-25660edfc2b7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "2f3c70f5-c285-4f90-866c-a15f13f0cab5",
"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-07-05T22:16:41.9609575+00:00",
"date_create": "2026-07-05T22:16:41.9609575+00:00",
"date_update": "2026-07-05T22:16:41.9609575+00:00",
"updated_by_user_id": "5b94c628-a751-47d3-9a79-6ea83c82fa23",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-05T22:16:41.9609575+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-07-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-05T22:16:41.9609575+00:00",
"date_last_job": "2026-07-05T22:16:41.9609575+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-05T22:16:41.9609575+00:00",
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00",
"is_mobile_installation": true
},
"job_type_id": "27184376-34f1-4a66-8fb5-a9bd7d145056",
"job_type_code": "sample string 7",
"job_type": {
"id": "967779c8-89dd-4c14-80b3-78d020806efa",
"name": "sample string 2",
"sales_organization_id": "381f51bc-6a92-4750-b6a1-5b232fd78fc1",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00",
"code": "sample string 7"
},
"job_priority_id": "176041ca-a855-421e-85ce-70c7e4d894c2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f5eb576a-23ec-4533-81e3-f07ad4a19ba1",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a8cb8aac-4512-4e61-a26e-16915a2eeb41",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"job_status_id": "5eb1a88a-d8d8-4ccf-bd8c-1dd4e4c39f9f",
"job_status_code": "sample string 11",
"db_address_id": "6c5ef1fe-50b7-458f-883e-e5648fb84b04",
"contact_id": "0330c98c-49dc-4866-9a48-ea4476d2f7bc",
"requested_by_company_id": "d45fe145-887d-4f49-8922-1b4a30e5f823",
"requested_by_contact_id": "8ebeaf3d-ea29-49a3-a734-0094ae707891",
"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-07-05T22:16:41.9609575+00:00",
"due_date": "2026-07-05T22:16:41.9609575+00:00",
"date_create": "2026-07-05T22:16:41.9609575+00:00",
"date_update": "2026-07-05T22:16:41.9609575+00:00",
"date_closed": "2026-07-05T22:16:41.9609575+00:00",
"suggested_user_id": "35033978-726f-4f0d-ba33-fa4436f2b9a3",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c25b4d6a-87b0-4a83-9596-7d91b1c2b9c9",
"db_language_id": "9b0328a9-a889-4b66-ac58-c04f31f0a8de",
"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-07-05T22:16:41.9609575+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c306dfa0-3b75-4778-ab89-424f818a6b1d",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e87fd2d4-65ed-4be8-ad85-d756e381748e",
"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": "b5c525eb-940c-4353-94fc-817471b7fc28",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "055fd70c-f549-459a-b829-442118fb8aa3"
},
"suggested_date_start": "2026-07-05T22:16:41.9609575+00:00",
"skill_id": "63b7e57f-2b76-4249-b48c-4c4451c41246",
"skill_code": "sample string 32",
"skill": {
"id": "dc2ff664-d881-4273-8f30-464deef11646",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5069fdfc-6dd1-48ba-be57-6d28c6a6a6e8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "8f4788f6-db8c-4706-8cff-fd658d1b74e0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "98d49f8f-1a94-4321-88ed-39ec60839547",
"db_currency_id": "87efb39c-3d01-4b24-ad09-9c46a08d3088",
"db_language_id": "ae28a0f0-42f2-4887-bef4-753de5cda2b8",
"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-07-05T22:16:41.9609575+00:00"
},
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2c7303d3-73a1-48fb-a63e-ea3bcb523fd3",
"date_reported_by_company": "2026-07-05T22:16:41.9609575+00:00",
"id2": 36,
"company_id": "de95b451-76da-40b9-8eb6-b041e8d82edb",
"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": "05a0b901-edda-436e-9f45-8bc735a57186",
"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-07-05T22:16:41.9609575+00:00"
},
"work_instruction_details_id": "e2251a78-26b5-47b7-a056-4c768d3c9c31",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "6866bf0d-5107-4c37-80f5-dfecc4a64487",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b41fb274-1e2b-440f-af16-f79fae410ab3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-05T22:16:41.9609575+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": "9ca27375-b605-4179-adfe-2561eb744adf",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-05T22:16:41.9609575+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.