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": "0b5a3a8f-7ced-4b87-81db-c2ed1ffe2cec",
"jobs_id": "9cfbf3df-344b-4407-aa4a-2eec0fadd2cd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5c8492ef-101b-46eb-85c5-dfe2451b8cc5",
"_parent_id": "ae0c7930-ec65-484f-8cbf-aa95d99d0530",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "69392a60-cf2d-4283-b89b-ca7e5723c28f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8bae9ba5-b555-4767-a699-b5c08106c494",
"_parent_id": "7301a376-df3a-4d4c-ba46-b2b71bd8442e",
"root_parent_id": "5d852e57-7f05-411b-a204-4e4d84b2738a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "cc02b82d-43c6-404a-96ea-2f18f80f9442",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f76c277c-7960-421b-a72d-6c926e7c7fd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eee632f2-470e-4cdd-bfdc-bedf2cee20f3",
"_parent_code": "sample string 6",
"sales_organization_id": "085d3077-c226-4030-8d8d-b29bb666b33f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"equipment_model_id": "2085044d-a31a-4002-8cb6-9bc90c018d71",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "b53a28fe-0343-4e79-ba8a-00458fa11df8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "64774ff9-1cf5-46fd-921b-2532297ad53b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "ba36c4df-9c91-41cc-a1ba-f41f8e98cf19",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c3a35ebc-b7af-468c-bf8b-c2cb33066daf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"equipment_family_id": "73b49eb3-5b51-4b5f-a82e-833064dff61c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f76c277c-7960-421b-a72d-6c926e7c7fd1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "eee632f2-470e-4cdd-bfdc-bedf2cee20f3",
"_parent_code": "sample string 6",
"sales_organization_id": "085d3077-c226-4030-8d8d-b29bb666b33f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"date_in_production_since": "2026-01-16T04:07:41.2319309+00:00",
"date_out_of_production_since": "2026-01-16T04:07:41.2319309+00:00",
"date_end_support": "2026-01-16T04:07:41.2319309+00:00",
"sales_organization_id": "575d9e9d-cacd-4222-84cb-174b8baee858",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+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-01-16T04:07:41.2319309+00:00"
},
"project_status_id": "a53ae8b1-1612-49b2-8dff-5961d9e1ddbf",
"project_status_code": "sample string 10",
"project_status": {
"id": "5528d6e0-e95d-4c4e-942d-2f49a3581c53",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b3644bfe-1528-45ad-9db9-a8aeb61dd8bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"company_id": "c7644cab-3956-4e5f-a20d-598ab2bc7bea",
"company_code": "sample string 12",
"db_address_id": "d87d0cf5-dac3-4d18-ad4c-0f69d0224af5",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "329409d0-de44-4339-a01e-638acc8c4be9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3084136e-f035-40a6-857d-2c65f59f9278",
"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-01-16T04:07:41.2319309+00:00",
"date_create": "2026-01-16T04:07:41.2319309+00:00",
"date_update": "2026-01-16T04:07:41.2319309+00:00",
"updated_by_user_id": "5225136f-8e0b-42f1-b161-51634d69fe8c",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-16T04:07:41.2319309+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-01-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-16T04:07:41.2319309+00:00",
"date_last_job": "2026-01-16T04:07:41.2319309+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-16T04:07:41.2319309+00:00",
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00",
"is_mobile_installation": true
},
"job_type_id": "7d14a78e-874d-472e-82d5-831ba05798ca",
"job_type_code": "sample string 7",
"job_type": {
"id": "e5ec9c88-5c01-4384-9935-d9ee0295a566",
"name": "sample string 2",
"sales_organization_id": "f8582623-a191-46f6-90e2-d3a00616a085",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00",
"code": "sample string 7"
},
"job_priority_id": "e2ed9b1e-4202-43fc-8865-658749d8e469",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a8011c2c-c67b-4dd1-95c8-2dc994acec73",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "68a0db3c-1995-40f5-83d1-ea238c51639d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"job_status_id": "281cd305-1f5c-4cae-8646-9ef18ccbcabd",
"job_status_code": "sample string 11",
"db_address_id": "7591145b-bbc6-485b-b13c-d05473c4a69d",
"contact_id": "09b6bc5b-9e72-4642-88f7-b0f28188f4a7",
"requested_by_company_id": "89d17352-db5a-4441-bdc5-2448f00f42ff",
"requested_by_contact_id": "02d09acf-1369-479b-acca-ba84ee6845f9",
"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-01-16T04:07:41.2319309+00:00",
"due_date": "2026-01-16T04:07:41.2319309+00:00",
"date_create": "2026-01-16T04:07:41.2319309+00:00",
"date_update": "2026-01-16T04:07:41.2319309+00:00",
"date_closed": "2026-01-16T04:07:41.2319309+00:00",
"suggested_user_id": "0077f7f8-3fb2-456f-91f1-e14b708866f0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "93d669a5-fc34-4c1d-8d87-8113767f015e",
"db_language_id": "4d087c53-42ed-4ef5-b4d1-23a43ca94b1a",
"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-01-16T04:07:41.2319309+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5b4efb27-96e6-43f8-bbc2-6f4e52ed2855",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d047a2f0-f569-47fc-87f9-d873a2c3f049",
"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": "6f498b8d-3d9a-45f9-879f-09840c075c1d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "692fbf02-a9eb-4d91-bf29-63e29724c46c"
},
"suggested_date_start": "2026-01-16T04:07:41.2319309+00:00",
"skill_id": "679bcc84-3d7e-4626-81a1-5358aeae92cc",
"skill_code": "sample string 32",
"skill": {
"id": "7455a6fc-c82d-47f1-9674-8b8e851196fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "c449f3b9-c47f-4a01-ba33-5e0f37b6b773",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "5e4b01dc-e80b-4a5d-85e8-2acfec7c0b4f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "f7dce486-8d15-4920-b41e-ddefaa46defa",
"db_currency_id": "1cf4dc7b-86db-467b-b176-c63440382f66",
"db_language_id": "ee2551b8-81cf-4e67-b5ef-e889b95d78c6",
"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-01-16T04:07:41.2319309+00:00"
},
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "78e2ab84-0777-41f7-aac7-7f1b97264cf0",
"date_reported_by_company": "2026-01-16T04:07:41.2319309+00:00",
"id2": 36,
"company_id": "c49fc4ab-58b8-4c62-a96c-213dba9eff17",
"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": "7c28fd9e-b786-4665-9140-31aa7cb15686",
"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-01-16T04:07:41.2319309+00:00"
},
"work_instruction_details_id": "d007d58c-d189-435e-9845-1af0d1444eb3",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "d6ce13e3-e82b-4b48-a9ea-8b8378085902",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "a6d84ead-c991-4269-a7e7-a27eb76963b2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-16T04:07:41.2319309+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": "25f362ec-ed40-44b4-a158-bb0ede00adf7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-16T04:07:41.2319309+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.