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": "e8314356-3911-4e66-82b4-fd1de0dd56be",
"jobs_id": "b7b37f79-4da3-422c-b3c8-4fdd038f8125",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "d0263d22-c675-46a4-9129-310ff8e2c4ee",
"_parent_id": "d76b6b9e-a46d-483d-b8f6-6da997f52261",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6bca6e17-b06b-40b7-9e1a-f7d3c986dc3b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "811326fe-781a-4783-8e2f-5b5b9030a970",
"_parent_id": "6a4cd804-8b92-4fde-9f9a-4bbd058285af",
"root_parent_id": "2081c7af-3240-445e-9eca-b66f977edd9f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "aa806268-66e8-4c7e-8a98-7ef5d68973bd",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "cc8be7c2-0a2f-46c9-ab1f-3a9bc7ffff04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc87b985-6ee3-48b6-ac89-3ba1700ea5ec",
"_parent_code": "sample string 6",
"sales_organization_id": "f5709b24-7b15-437e-8834-57af927d4f33",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"equipment_model_id": "0ee72517-b6d1-4d0e-9f12-88748d7bd024",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c449797f-52f9-46e3-bc75-a234be56afa1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e362407b-dadb-429f-9fac-7031f2c8593a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6b977261-1853-4bbd-9323-3705ba8299ca",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ce0f224b-6cca-4365-aa53-42f199aa28a9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"equipment_family_id": "910526ad-be99-4712-b644-2d990fbab8fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "cc8be7c2-0a2f-46c9-ab1f-3a9bc7ffff04",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "fc87b985-6ee3-48b6-ac89-3ba1700ea5ec",
"_parent_code": "sample string 6",
"sales_organization_id": "f5709b24-7b15-437e-8834-57af927d4f33",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"date_in_production_since": "2026-08-05T04:54:30.914239+00:00",
"date_out_of_production_since": "2026-08-05T04:54:30.914239+00:00",
"date_end_support": "2026-08-05T04:54:30.914239+00:00",
"sales_organization_id": "07752d06-652b-4cff-9c6a-0cd6cf4849b6",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+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-08-05T04:54:30.914239+00:00"
},
"project_status_id": "f90b3227-64a9-4df2-83ec-38ed15d98862",
"project_status_code": "sample string 10",
"project_status": {
"id": "a42d4d9e-4a37-410d-a028-542eab3b9781",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3ab55657-e2e6-45e1-9bee-e645d02236bc",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"company_id": "e28f34b8-6428-447d-9497-efef821444e1",
"company_code": "sample string 12",
"db_address_id": "8a4ab164-71c3-4e32-b6fd-518f0049c21f",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "64eb7557-a8cd-4db1-a329-b4f26bc7def1",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d371d664-675c-4534-bc89-92c4e918e815",
"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-08-05T04:54:30.914239+00:00",
"date_create": "2026-08-05T04:54:30.914239+00:00",
"date_update": "2026-08-05T04:54:30.914239+00:00",
"updated_by_user_id": "60ed0458-cf63-4338-a7dd-e1c2c958e21d",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-05T04:54:30.914239+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-08-05T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-05T04:54:30.914239+00:00",
"date_last_job": "2026-08-05T04:54:30.914239+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-05T04:54:30.914239+00:00",
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00",
"is_mobile_installation": true
},
"job_type_id": "d47b2220-a1cd-41b8-9e73-1b7bc633e6af",
"job_type_code": "sample string 7",
"job_type": {
"id": "ca5668ba-ff46-4458-8cae-a979b409675c",
"name": "sample string 2",
"sales_organization_id": "c434548b-3c1e-4a5c-9b52-071bc047ef18",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00",
"code": "sample string 7"
},
"job_priority_id": "dbaf2a0b-0b61-4016-9fcd-27bb3830034c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "49ee7c70-627b-4c66-a743-7038825fe05f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0d13be22-2e1f-4010-80cd-bac39d571376",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"job_status_id": "d92f80d2-5f9e-4605-9d50-e727dfe104ff",
"job_status_code": "sample string 11",
"db_address_id": "a5e100c2-6ec3-4344-bf82-13abe706bf39",
"contact_id": "e01fb40c-b082-4443-a847-317852532e33",
"requested_by_company_id": "6c4deeed-bd69-4f69-825d-32085f58f2ee",
"requested_by_contact_id": "77d78faf-01aa-44de-be3a-5e10a094930d",
"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-08-05T04:54:30.914239+00:00",
"due_date": "2026-08-05T04:54:30.914239+00:00",
"date_create": "2026-08-05T04:54:30.914239+00:00",
"date_update": "2026-08-05T04:54:30.914239+00:00",
"date_closed": "2026-08-05T04:54:30.914239+00:00",
"suggested_user_id": "eae3897d-be7d-40a0-869e-27db444620e8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "4b4fcc87-cc0d-45d5-9b7e-dd4813156d39",
"db_language_id": "df0580eb-f1f9-4a50-8a47-a9777d890b22",
"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-08-05T04:54:30.914239+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3332e0a6-e4f6-49f2-b2d3-b72fa834cf40",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cb253fc1-b3de-4265-a9e2-ad9d7f2eac0b",
"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": "b8b9c1bb-fd76-4cf5-9177-243b2f0c1846",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "af9a7ee1-3915-4d99-b92f-c3e276fca7eb"
},
"suggested_date_start": "2026-08-05T04:54:30.914239+00:00",
"skill_id": "adb328f2-d770-4d2e-a943-1d9e7d8b6ed0",
"skill_code": "sample string 32",
"skill": {
"id": "254f7166-e9de-4659-aae6-0d31b364d1fd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8c583b5c-1c81-416a-af9d-18d0e09b0e34",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9e281d57-0284-4b3d-b2ef-9d333f2053d8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b8072077-cba9-41f3-8ab9-e7bc680373b3",
"db_currency_id": "cf1a458c-4627-4285-a820-c4415cdbb627",
"db_language_id": "7caf0bae-07a0-4874-a6e8-88190b5c9601",
"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-08-05T04:54:30.914239+00:00"
},
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f08365b5-be50-4e18-a11a-853bb7bfe50d",
"date_reported_by_company": "2026-08-05T04:54:30.914239+00:00",
"id2": 36,
"company_id": "6fecd553-91cc-4a23-ad33-8ffccbf626a6",
"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": "02787b57-282f-405f-8d5a-6e02e1e5fae3",
"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-08-05T04:54:30.914239+00:00"
},
"work_instruction_details_id": "5cb615fa-5f1d-4301-a8b8-014f9617926c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2b08c817-acb0-4ff9-ae3c-f07f249e88d2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "9197d3a5-041f-4c16-ac06-230d9b6ac6e4",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-05T04:54:30.914239+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": "9bf0e6df-dc2a-4eab-b2e9-6df50ba9c146",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-05T04:54:30.914239+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.