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": "10f8c29a-5b8b-469d-889d-572f6a04cf91",
"jobs_id": "3bb9936d-7055-4871-9252-dee39e244cf0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c0783ea4-efc4-4acb-b632-5d27e17f9525",
"_parent_id": "1b7346af-b5a1-4ad4-8b05-5536e3b471c5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "befce84f-47df-4375-87a5-75102edce5c4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4afcae4b-6515-4a26-b42f-448d36f99014",
"_parent_id": "9e89a027-d356-4796-b2c0-6b3c9022b506",
"root_parent_id": "54d60649-c653-4a27-9612-a34aafb3f11c",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3f9266e-ae4e-4aee-bc36-2d1991344476",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "06b7c151-2909-404f-9925-7aa27bbc62c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d05bea10-71e8-4779-9143-3b9e6883eec1",
"_parent_code": "sample string 6",
"sales_organization_id": "77b228c1-6cc5-492c-a34b-49b5918db0fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"equipment_model_id": "d8001a11-7819-431a-a1ff-34bd1c674e55",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "5127918f-8451-446f-96a5-aae76b1d9a0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b45c0300-8e42-4df4-965b-dcf2caf28b2b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3de43329-b013-4772-ac90-31faaf63afb0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "e9804b4e-1f17-4596-b5a3-ec918d7f6d94",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"equipment_family_id": "441cbb7a-6912-4817-b7ca-1eab882b4c9d",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "06b7c151-2909-404f-9925-7aa27bbc62c5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d05bea10-71e8-4779-9143-3b9e6883eec1",
"_parent_code": "sample string 6",
"sales_organization_id": "77b228c1-6cc5-492c-a34b-49b5918db0fc",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"date_in_production_since": "2026-09-23T05:27:03.306929+00:00",
"date_out_of_production_since": "2026-09-23T05:27:03.306929+00:00",
"date_end_support": "2026-09-23T05:27:03.306929+00:00",
"sales_organization_id": "72c1df25-c589-420d-94cb-286a62fbeda4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+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-23T05:27:03.306929+00:00"
},
"project_status_id": "93f8bd40-19fa-49ea-9bbf-7aadfc79a9b5",
"project_status_code": "sample string 10",
"project_status": {
"id": "ed1b2d19-dff8-4ac1-a580-7447c5d4e487",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e152978a-03f5-43a1-a372-f4955a4a7405",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"company_id": "97db22aa-41e5-4de1-9d10-3bfddabff8e9",
"company_code": "sample string 12",
"db_address_id": "a37235ae-f4ea-4d7a-ad4c-64b76d412c57",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "b38dc563-343a-454f-be1b-37fdad025524",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e3b2c5b4-7601-47fe-8d3f-3b21725cfeba",
"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-23T05:27:03.306929+00:00",
"date_create": "2026-09-23T05:27:03.306929+00:00",
"date_update": "2026-09-23T05:27:03.306929+00:00",
"updated_by_user_id": "208e97a5-061a-436f-a33c-1b7484ce6fe7",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-23T05:27:03.306929+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-23T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-23T05:27:03.306929+00:00",
"date_last_job": "2026-09-23T05:27:03.306929+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-23T05:27:03.306929+00:00",
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae332478-4fd2-453d-a195-06511bb6973c",
"job_type_code": "sample string 7",
"job_type": {
"id": "8db0e6ce-a65e-4db2-af33-2d417fd202eb",
"name": "sample string 2",
"sales_organization_id": "f97a3f3a-010d-4a13-b5e4-77ba0937552e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00",
"code": "sample string 7"
},
"job_priority_id": "a22155fa-2658-428d-b453-83dbb33ae392",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "d208a8cc-60a4-4d07-bf9c-4f9f783d9a6f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "92ebc445-f012-40ee-83ee-0d15353ebd86",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"job_status_id": "06398801-6e8e-45c8-9974-0f75a539d07d",
"job_status_code": "sample string 11",
"db_address_id": "3fd64d88-1ec8-4e68-88e0-dc9e874cb205",
"contact_id": "c2bb407d-292c-4bcd-8e5c-b51b05e94977",
"requested_by_company_id": "50c6aae7-946d-486c-8d3f-9ba4122835b2",
"requested_by_contact_id": "d39629c7-0827-49cb-af40-f8ae24fe303f",
"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-23T05:27:03.306929+00:00",
"due_date": "2026-09-23T05:27:03.306929+00:00",
"date_create": "2026-09-23T05:27:03.306929+00:00",
"date_update": "2026-09-23T05:27:03.306929+00:00",
"date_closed": "2026-09-23T05:27:03.306929+00:00",
"suggested_user_id": "9b13c7f9-1309-471d-b0e1-b37c06849c43",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e5fb69f3-1c09-4c3e-9d79-1e6661c198a0",
"db_language_id": "e00af3d9-92ba-4fca-b624-09687b4d5c20",
"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-23T05:27:03.306929+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "471ace32-fb66-4827-9083-c853faec268f",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "48f861d2-5231-4a71-97dd-46ee65f6bfa9",
"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": "aca81ec0-f7bb-455a-9b05-9be27e2cea76",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "da59b700-d22e-4506-afb6-083e4802864a"
},
"suggested_date_start": "2026-09-23T05:27:03.306929+00:00",
"skill_id": "5e33461b-e392-4c62-b905-056972d15215",
"skill_code": "sample string 32",
"skill": {
"id": "ac37ee84-0183-4c23-9a65-e37da3723fdc",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "db72ebd5-e625-403e-8fa7-f9ee184e5c0a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ee916cf7-ecf6-4859-b707-b1f937e2b5e8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "41cd6192-f052-40e6-81d7-5ba2ecd6ca2f",
"db_currency_id": "c8870066-2129-4497-9fa8-c97ff9450c65",
"db_language_id": "18640abe-652a-4694-af8c-40990316a074",
"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-23T05:27:03.306929+00:00"
},
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "288ca2f7-e117-4fb2-acf1-12c8a35d19e7",
"date_reported_by_company": "2026-09-23T05:27:03.306929+00:00",
"id2": 36,
"company_id": "0ed6ae20-49af-42b5-8348-efdb4589557e",
"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": "0eb005d7-6d1e-4cc7-955f-1b94a04529ce",
"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-23T05:27:03.306929+00:00"
},
"work_instruction_details_id": "b7d2781a-3ce6-45d7-8097-6454d0ec80f1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "29f22865-b000-43b2-8779-6d09387badef",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bac1f06e-d230-4440-a116-c1a3f93bd6ca",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-23T05:27:03.306929+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": "81b83de0-ebba-4290-8fc1-eded49da46db",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-23T05:27:03.306929+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.