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": "932ae61d-588c-42c4-b123-398fe56d3999",
"jobs_id": "9602cb7e-61b4-4bdb-955e-09f2e3a7ad4a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7657d652-a377-4b15-b23f-4177ea1cd013",
"_parent_id": "ea582b23-94ec-4552-877e-071496740cea",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ad2b96fa-134f-465c-a23b-da6ac0f522cf",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5370cc38-39bb-4eef-b808-07169e7ef4bc",
"_parent_id": "296aa5df-79d4-470a-83e9-2ad84d622226",
"root_parent_id": "2bae8f06-0992-4189-969a-ea51f88a84f4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "15f4323e-1ecb-4ce9-b5b7-f47aac0dc4a9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f606dbe9-f90a-4c9c-b58e-238801fde34a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5dd6e179-f960-4f32-8841-58ffd08426b5",
"_parent_code": "sample string 6",
"sales_organization_id": "75278e1c-1844-46e1-9dfc-8999f0401fc6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"equipment_model_id": "e11871d7-17a4-4ac4-870c-0c089e0c8a09",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "9c99d392-839c-4085-969b-7f639d7c7eac",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e66d37eb-c61a-454b-bb78-635a8b6248ad",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "55fce233-6466-4588-ac9c-07ef99d2f3f6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3a493d6c-c435-4cb6-98d4-ef34e1458e9c",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"equipment_family_id": "4fb94022-1ff6-49ab-b423-dc9ac2a7062c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f606dbe9-f90a-4c9c-b58e-238801fde34a",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5dd6e179-f960-4f32-8841-58ffd08426b5",
"_parent_code": "sample string 6",
"sales_organization_id": "75278e1c-1844-46e1-9dfc-8999f0401fc6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"date_in_production_since": "2025-12-08T03:41:09.2864298+00:00",
"date_out_of_production_since": "2025-12-08T03:41:09.2864298+00:00",
"date_end_support": "2025-12-08T03:41:09.2864298+00:00",
"sales_organization_id": "2387e76f-da5a-4937-9adf-5064157772cb",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+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-12-08T03:41:09.2864298+00:00"
},
"project_status_id": "95ffa6be-5717-4e64-95e3-0ceb7dee38c2",
"project_status_code": "sample string 10",
"project_status": {
"id": "2dd348eb-7aa5-4902-b3ce-59a95157d42d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "65467bef-6c3d-413c-ac9f-f6ffc3e3a76c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"company_id": "0c7f1a1f-8a5f-4b5d-9587-c384620d8c7f",
"company_code": "sample string 12",
"db_address_id": "3ac28dce-f741-428a-8b35-72741701c303",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "88b88219-9f4e-40cb-b217-fb91a3c8b5f1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d86b50a1-1935-4d40-8e0f-98895ec00f2d",
"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-12-08T03:41:09.2864298+00:00",
"date_create": "2025-12-08T03:41:09.2864298+00:00",
"date_update": "2025-12-08T03:41:09.2864298+00:00",
"updated_by_user_id": "3e37a854-fbc2-4f28-a641-df2f902432b8",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-08T03:41:09.2864298+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-12-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-08T03:41:09.2864298+00:00",
"date_last_job": "2025-12-08T03:41:09.2864298+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-08T03:41:09.2864298+00:00",
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00",
"is_mobile_installation": true
},
"job_type_id": "7fd6bdf7-90d9-4335-a35b-e0f1cda6d479",
"job_type_code": "sample string 7",
"job_type": {
"id": "1f4ae6cc-e50e-47f9-a0e3-2f46c29f6771",
"name": "sample string 2",
"sales_organization_id": "870075fc-e13c-4373-a1bd-1cdccaa9ede0",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00",
"code": "sample string 7"
},
"job_priority_id": "fe09a376-8f24-4827-babf-d47c7dd7a946",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5dab5327-f607-4b42-96a0-fce63d624bc9",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "9e6bf6cf-64a5-49e1-8906-940f193deda0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"job_status_id": "c0673224-2c5a-4e61-b1b4-26e099501e7a",
"job_status_code": "sample string 11",
"db_address_id": "583a58ad-590d-4f18-addd-ae744a8fc9d2",
"contact_id": "e57eb48c-e576-406a-ac50-d63f489e6a6b",
"requested_by_company_id": "f0e5186e-df93-49c2-ad06-6b35731e4c14",
"requested_by_contact_id": "1e12b7fd-212c-44f4-8081-867e284fde5c",
"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-12-08T03:41:09.2864298+00:00",
"due_date": "2025-12-08T03:41:09.2864298+00:00",
"date_create": "2025-12-08T03:41:09.2864298+00:00",
"date_update": "2025-12-08T03:41:09.2864298+00:00",
"date_closed": "2025-12-08T03:41:09.2864298+00:00",
"suggested_user_id": "ee52356f-392c-4ae3-b76e-568ab31cad4d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "67ee5760-768f-4f79-8802-a74efda535c1",
"db_language_id": "1305c91c-e7cd-499c-87ee-295d611501f7",
"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-12-08T03:41:09.2864298+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8e35a315-bb57-4c9e-8a2a-423f783b4ef4",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "479f541b-d5ab-4209-b8c8-e81e03ef2c46",
"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": "e8b50365-6011-4208-8ceb-d19cb4afb72c",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5a3b0105-aabc-406e-91ff-a8472cc17df5"
},
"suggested_date_start": "2025-12-08T03:41:09.2864298+00:00",
"skill_id": "b00d8728-a516-4277-a71d-af1c7723a34a",
"skill_code": "sample string 32",
"skill": {
"id": "39b63aff-895f-43c9-85f3-9e074e099644",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1489dd19-41c0-46f9-bd3e-87507653af38",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "fc3bcc67-44f4-4522-a40e-ce5dbc351440",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b581ac19-c20c-4043-9414-04d5767a973d",
"db_currency_id": "73c924ba-6375-4846-a126-ae6dc3754cfd",
"db_language_id": "c7dbbfba-40d4-4632-a9cd-d49d6cd540dc",
"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-12-08T03:41:09.2864298+00:00"
},
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "54c4db7f-b0e5-467b-906a-3c34bd979884",
"date_reported_by_company": "2025-12-08T03:41:09.2864298+00:00",
"id2": 36,
"company_id": "ad8286c8-f2c6-4f33-8e13-38016b672010",
"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": "e14d1d01-0eae-4c42-a8b0-9ced3283594a",
"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-12-08T03:41:09.2864298+00:00"
},
"work_instruction_details_id": "3b0270a1-48ec-4fea-87dc-eb8c77328f50",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "46e67094-d36e-4de4-9089-9c22e70f24b2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "99c8b08f-eb5a-482b-b6f6-959c8ef9ac49",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-08T03:41:09.2864298+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": "b8619a2e-32da-44cc-bf36-7071ba0b6e0f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-08T03:41:09.2864298+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.