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": "fc559ada-1274-40ad-ac68-8baff2258820",
"jobs_id": "80fd493f-e4d3-4ad7-aab6-a7478493ce61",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4249e75c-1fc8-4269-9339-2cbd0a2fb680",
"_parent_id": "e705e509-d237-4ed5-b401-bc70feaeed1b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ac3ed2b9-e88c-4537-a9c6-cd02ea13fefe",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3be9f5d1-ad50-4381-be44-7a2a7724a031",
"_parent_id": "8413a718-af64-4cad-8c24-34688aa07777",
"root_parent_id": "113b3d4f-e272-485f-970d-da2fb12909b7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "14e5f832-adec-4652-b324-144739e498d2",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "68b4737b-3287-481a-84c9-4236fc039cce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "389cefe4-3d21-4e97-94ec-aa412744369b",
"_parent_code": "sample string 6",
"sales_organization_id": "b2b02a67-b4d2-437e-a77d-86118e3db00b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"modified_dateutc": "2026-10-10T04:03:58.3028952+00:00"
},
"equipment_model_id": "76b85421-3b9c-455d-b0f3-585458f27440",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e69ce02-0c3f-4917-a65a-04056dc85500",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "83a70c61-cd89-43dd-86a1-f21f6298fd20",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "64e950c4-5dd9-4aa3-bd27-3c4b1afc7dda",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "034484d9-3cb7-4478-8522-aa3f8276e3df",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"modified_dateutc": "2026-10-10T04:03:58.3028952+00:00"
},
"equipment_family_id": "fc8e57c5-deb3-4a63-9f15-53805705a0d2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "68b4737b-3287-481a-84c9-4236fc039cce",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "389cefe4-3d21-4e97-94ec-aa412744369b",
"_parent_code": "sample string 6",
"sales_organization_id": "b2b02a67-b4d2-437e-a77d-86118e3db00b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"modified_dateutc": "2026-10-10T04:03:58.3028952+00:00"
},
"date_in_production_since": "2026-10-10T04:03:58.3028952+00:00",
"date_out_of_production_since": "2026-10-10T04:03:58.3028952+00:00",
"date_end_support": "2026-10-10T04:03:58.3028952+00:00",
"sales_organization_id": "7db1e157-b1ba-40bb-95f1-bfa9b9e14d68",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+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-10-10T04:03:58.3217386+00:00"
},
"project_status_id": "626dc0a2-7f48-469c-b3fe-c1115d962bf6",
"project_status_code": "sample string 10",
"project_status": {
"id": "9c869200-b97d-4dc4-9f7b-4c3f35e1450a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f8a7836e-3ea6-4803-8035-c6cb3eb00b22",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00"
},
"company_id": "0b10cd55-bb5b-4045-a2e4-c2fc8051d281",
"company_code": "sample string 12",
"db_address_id": "a1760f65-7b92-4478-8d13-2edaedc75f78",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "89297d8e-43e4-4757-a608-1dc16d47f667",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7d81efc1-a218-40c3-a5f5-021db9ac5369",
"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-10-10T04:03:58.3217386+00:00",
"date_create": "2026-10-10T04:03:58.3217386+00:00",
"date_update": "2026-10-10T04:03:58.3217386+00:00",
"updated_by_user_id": "2911c1d7-c386-4785-905a-1038318e61b7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-10T04:03:58.3217386+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-10-10T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-10T04:03:58.3217386+00:00",
"date_last_job": "2026-10-10T04:03:58.3217386+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-10T04:03:58.3217386+00:00",
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00",
"is_mobile_installation": true
},
"job_type_id": "66e655ff-17e2-47ca-909a-dd4686646833",
"job_type_code": "sample string 7",
"job_type": {
"id": "34606013-3d5b-403c-8bf8-f74bc171f82c",
"name": "sample string 2",
"sales_organization_id": "e2171605-4536-40a7-8fb6-88b0684e5a5e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00",
"code": "sample string 7"
},
"job_priority_id": "de28b384-8e26-42bd-942e-5ccf21f93476",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a4053174-52ad-4c34-9344-add77c4e1fbc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "14fb2d1a-e173-43a7-bff1-d70f8283ac70",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00"
},
"job_status_id": "56c35e28-c316-40f0-b954-6fe806711fef",
"job_status_code": "sample string 11",
"db_address_id": "da6ef354-1140-45d5-9e21-c8f83a806d9a",
"contact_id": "1898b19f-b78b-4fd3-b40e-33b80b003410",
"requested_by_company_id": "1ef4d8f2-2332-4015-b1d6-df0e7b83bd69",
"requested_by_contact_id": "16ed9084-517f-4477-97f3-78b445febc6e",
"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-10-10T04:03:58.3217386+00:00",
"due_date": "2026-10-10T04:03:58.3217386+00:00",
"date_create": "2026-10-10T04:03:58.3217386+00:00",
"date_update": "2026-10-10T04:03:58.3217386+00:00",
"date_closed": "2026-10-10T04:03:58.3217386+00:00",
"suggested_user_id": "acadf7ae-f93b-4cd8-8c47-0e392c7e9f6d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "cff4c059-f2ca-4180-99ee-a19253cd8b17",
"db_language_id": "c7ec9c9c-b7bf-4bc3-8169-3a3ff4b837c4",
"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-10-10T04:03:58.3217386+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "881a39cd-1877-44ee-b6e8-f035b601e24b",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "abd6787d-8c9e-49d7-bb09-d2215fb0021f",
"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": "5e2c0ce7-717e-4929-af16-888a53641736",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "7cfc87b1-351c-489a-a997-8f8980b6b965"
},
"suggested_date_start": "2026-10-10T04:03:58.3217386+00:00",
"skill_id": "c2f5a270-24ce-4f61-916b-4f15258c1fc6",
"skill_code": "sample string 32",
"skill": {
"id": "2e63fe03-1e4d-4b93-bfb9-92785fdccd55",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4c6fe60c-3d4c-421e-80a2-72f9797cd400",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2da9b1-90d6-4b03-b17b-57d974632f65",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8216c922-7e43-468a-a1d6-ff988556170d",
"db_currency_id": "4fdd3878-24a3-473e-a7eb-bbd19d90779c",
"db_language_id": "7248f5e1-6cfc-40da-a934-4442601d9659",
"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-10-10T04:03:58.3028952+00:00"
},
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "664666d7-4d6e-4947-bdbb-87a34755280e",
"date_reported_by_company": "2026-10-10T04:03:58.3217386+00:00",
"id2": 36,
"company_id": "c9476c46-5452-4646-8bd7-920cd6db78d0",
"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": "47772c9a-d219-48b4-ab50-d3967e6b3a1d",
"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-10-10T04:03:58.3217386+00:00"
},
"work_instruction_details_id": "2599f00c-a8bd-4f71-b017-09669b18edf9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b99ba235-4f54-4749-a05d-607bc8aa13ba",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f8f92287-58cf-410e-9f64-8c6a881e601b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-10T04:03:58.3217386+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": "71f10dbb-77c1-4e56-82d0-c345a48b0f04",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-10T04:03:58.3217386+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.