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": "cca418b4-bbaa-445c-8da1-3e3de5da7068",
"jobs_id": "8de14c45-456a-4080-bbab-ea9702bd964b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "66b55edb-70e3-4bf2-8e58-bc65e13528e6",
"_parent_id": "80a3f816-5fb6-4d0b-a381-12c1dff3aa16",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8f0d3086-4aa1-4170-87b3-089bd1f6e1d3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "02d39050-d277-4f9e-8c9b-96e458eee2df",
"_parent_id": "403fc13c-455b-40d8-b3b4-3d4bcbe60d60",
"root_parent_id": "86803855-208a-45ce-8a23-0c206f544be7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "bf290745-d4ef-469e-bc56-84c5f8e92829",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b278d0a6-db0c-47dd-a1e7-a3017af2ede2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "acc98dcd-e55e-48bb-b5df-649bd6f87f67",
"_parent_code": "sample string 6",
"sales_organization_id": "14269ebd-9d7f-4407-8124-c9e818702414",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"equipment_model_id": "b48653b9-4d7e-4ed1-8275-44df4948e367",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "a9201e3a-5ddd-4610-966f-3793e0ee1244",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f5ed8d70-062b-4c04-9f67-9e5e2ea35e4f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "37dbd372-7e40-4363-aea9-756cfae47b98",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bee16de5-d0c0-4acb-9996-17f2841641b5",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"equipment_family_id": "eeee7c6a-5151-4d65-a4f7-b639802e170c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b278d0a6-db0c-47dd-a1e7-a3017af2ede2",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "acc98dcd-e55e-48bb-b5df-649bd6f87f67",
"_parent_code": "sample string 6",
"sales_organization_id": "14269ebd-9d7f-4407-8124-c9e818702414",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"date_in_production_since": "2026-09-10T00:14:58.4824857+00:00",
"date_out_of_production_since": "2026-09-10T00:14:58.4824857+00:00",
"date_end_support": "2026-09-10T00:14:58.4824857+00:00",
"sales_organization_id": "ba22be2b-fdfe-400c-a65d-1d9462838dc6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+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-09-10T00:14:58.4824857+00:00"
},
"project_status_id": "da911cba-a281-4623-9a80-3d5542de1f30",
"project_status_code": "sample string 10",
"project_status": {
"id": "3da46333-e36c-4591-9ddf-5f34bc64c67d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7eda93b1-98c3-4c52-ae6f-ae25b3621dfb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"company_id": "b967e2db-8d64-4c80-9e1e-642ee56019a1",
"company_code": "sample string 12",
"db_address_id": "a6bdf747-89ef-4575-ac17-3cd97c8ccfed",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "a75e553d-9ed6-41bf-ba76-e35fe0720277",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c4e10555-cf76-486e-ade7-2ed0b0373320",
"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-09-10T00:14:58.4824857+00:00",
"date_create": "2026-09-10T00:14:58.4824857+00:00",
"date_update": "2026-09-10T00:14:58.4824857+00:00",
"updated_by_user_id": "454d32a3-d2fd-4988-b410-268310f04b88",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-10T00:14:58.4824857+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-09-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-10T00:14:58.4824857+00:00",
"date_last_job": "2026-09-10T00:14:58.4824857+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-10T00:14:58.4824857+00:00",
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00",
"is_mobile_installation": true
},
"job_type_id": "ac6e69fc-8545-484a-b350-cd4c62b1d1cc",
"job_type_code": "sample string 7",
"job_type": {
"id": "9cd247b7-78d6-4e5e-9d07-fe468a28f479",
"name": "sample string 2",
"sales_organization_id": "3a550d5d-2fb7-43ce-9333-d73d28f48670",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00",
"code": "sample string 7"
},
"job_priority_id": "42274f18-3015-4d81-9a7a-630cacdda708",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "3b5a4f90-6998-4b3b-8dca-deb7549394e7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6ffe9557-af30-497b-bfdf-458863c0256d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"job_status_id": "f3a400be-360f-4fb0-b024-218c1deacbb1",
"job_status_code": "sample string 11",
"db_address_id": "869d39af-44d1-4ff8-9795-7193dbe9cbcf",
"contact_id": "a5006e17-e384-432b-a807-f212725b296f",
"requested_by_company_id": "f90c401f-14cc-4334-849d-c969aa937238",
"requested_by_contact_id": "c7de2b84-b348-4b98-9b9f-5afd0d1103b2",
"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-09-10T00:14:58.4824857+00:00",
"due_date": "2026-09-10T00:14:58.4824857+00:00",
"date_create": "2026-09-10T00:14:58.4824857+00:00",
"date_update": "2026-09-10T00:14:58.4824857+00:00",
"date_closed": "2026-09-10T00:14:58.4824857+00:00",
"suggested_user_id": "60030819-466a-461b-b9e9-58adb230fcab",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "a0f6b463-6188-4044-bca3-effd629754b9",
"db_language_id": "960637c9-5d9a-407a-95f0-8aeaeae1ab02",
"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-09-10T00:14:58.4824857+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "e8def52d-65af-4026-afed-ba451536a9a0",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bd5578d6-6e13-4365-a6a3-8547ae8bf28a",
"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": "32571e22-713f-4559-a1b3-412c76c6c56b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "0eebfd85-81ea-4c35-bc9b-98847b46b2b2"
},
"suggested_date_start": "2026-09-10T00:14:58.4824857+00:00",
"skill_id": "57c246be-52c7-4ae4-82fd-ab5ada82ac2c",
"skill_code": "sample string 32",
"skill": {
"id": "2a0623cd-6ee6-4706-a6cd-64c77d0413c6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5c773ae0-3b75-4c81-bfbf-3887008f8df2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a0072165-7bf4-4203-ab97-3a634c3e1781",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a51c94f6-e338-4ac9-aa65-247c20054317",
"db_currency_id": "92b6af24-39e7-4899-9432-981e6df12dcb",
"db_language_id": "f8d5f4b8-f0fa-41b5-95c9-a11f62fa24d1",
"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-09-10T00:14:58.4824857+00:00"
},
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e6f89b4c-fa0c-4b6b-9a34-27db99f84aa1",
"date_reported_by_company": "2026-09-10T00:14:58.4824857+00:00",
"id2": 36,
"company_id": "412a3cc7-8b93-4286-9146-2ee42903ccc0",
"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": "58efe9c1-3c7b-4c5d-9a55-454483162a18",
"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-09-10T00:14:58.4824857+00:00"
},
"work_instruction_details_id": "604c464f-3ea1-41cf-b1ab-def95d442a6f",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e85793fc-38da-4887-be7f-4d73e9fc8dab",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "20f62466-60ea-40c0-ab84-b0d4840e5605",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-10T00:14:58.4824857+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": "634f6571-ffc7-445c-89b1-1807fd012e66",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-10T00:14:58.4824857+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.