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": "6da18a2d-c708-4cb5-90e9-6bfef63f0e20",
"jobs_id": "af70cb3f-216d-48c6-9c5b-8d92055ea4d5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0533d596-f40b-40a0-8219-a19625552c2c",
"_parent_id": "944279b0-22f5-45a0-98aa-b714c27d6887",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c8fac081-5656-444c-a503-b792c78ff475",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5fed5170-833d-412b-a7a1-5ef2f85a925b",
"_parent_id": "0264aa54-9c7b-488e-a13d-148c5abd21f3",
"root_parent_id": "be7f242c-4fce-4928-9af4-f85b843068ef",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8894238f-ff94-476e-994b-181e3adc4d73",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b9630ee1-d725-4ae6-b4ac-fbd39bd31cc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83e9fc31-e0e3-45ae-8b6f-70bcaedd79e7",
"_parent_code": "sample string 6",
"sales_organization_id": "acb0ca2e-f9c5-43c6-9da7-1449b82d2644",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"modified_dateutc": "2026-01-19T01:30:42.9755571+00:00"
},
"equipment_model_id": "f79ce84e-c18a-4f60-a05d-f00d1238f589",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "e6e94335-6509-42b6-a14f-c32c92a6bc98",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "0bb0a943-4613-4e06-8791-5a868d98d7da",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "251fe029-bcad-4a95-ad8d-68e80c1e6bd7",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "24f3a5bb-dd97-4b9a-b9db-9edc181970d0",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"modified_dateutc": "2026-01-19T01:30:42.9755571+00:00"
},
"equipment_family_id": "11999dc8-e513-4a0c-82a8-8704af9b55e6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b9630ee1-d725-4ae6-b4ac-fbd39bd31cc7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83e9fc31-e0e3-45ae-8b6f-70bcaedd79e7",
"_parent_code": "sample string 6",
"sales_organization_id": "acb0ca2e-f9c5-43c6-9da7-1449b82d2644",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"modified_dateutc": "2026-01-19T01:30:42.9755571+00:00"
},
"date_in_production_since": "2026-01-19T01:30:42.9755571+00:00",
"date_out_of_production_since": "2026-01-19T01:30:42.9755571+00:00",
"date_end_support": "2026-01-19T01:30:42.9755571+00:00",
"sales_organization_id": "fd0d6ef8-e154-4d6c-b0c4-7b365d161c10",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+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-01-19T01:30:42.9755571+00:00"
},
"project_status_id": "0487084c-2d12-4d69-9c2e-18f087527baf",
"project_status_code": "sample string 10",
"project_status": {
"id": "40ff6135-b4fd-44d1-9709-60558f32773e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "9d0f8627-5191-4d97-a1a8-b33a12a24838",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T01:30:42.9755571+00:00"
},
"company_id": "1f7afa35-ea72-4eea-a565-20a70f8ad383",
"company_code": "sample string 12",
"db_address_id": "39995916-728e-4eb6-aa27-40cf06f1f100",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c2101dda-4d14-4de9-9eb5-bfe51a6019e9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f62e32aa-9bb1-474b-851c-c80817dc4242",
"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-01-19T01:30:42.9755571+00:00",
"date_create": "2026-01-19T01:30:42.9755571+00:00",
"date_update": "2026-01-19T01:30:42.9911813+00:00",
"updated_by_user_id": "5d639e22-6533-4e10-a002-6f299a1847a5",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T01:30:42.9911813+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T01:30:42.9911813+00:00",
"date_last_job": "2026-01-19T01:30:42.9911813+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T01:30:42.9911813+00:00",
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00",
"is_mobile_installation": true
},
"job_type_id": "042fb61c-fcf6-4101-be09-a163fc30c328",
"job_type_code": "sample string 7",
"job_type": {
"id": "3f09543c-0bd7-404e-ae7e-5fba7d9c65d2",
"name": "sample string 2",
"sales_organization_id": "dee6949b-2c6d-4df1-a3e5-016485fffba8",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00",
"code": "sample string 7"
},
"job_priority_id": "0339f5d4-c529-46d1-8515-1175e80655a7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "33536b1d-bf3e-47e9-bf10-f928a8b69b78",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ccc93175-0544-47ca-a0f6-bad6ed159d02",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00"
},
"job_status_id": "e1229d16-a7b4-45f3-9e84-8bcbbe02ea8d",
"job_status_code": "sample string 11",
"db_address_id": "54b8be57-61ab-49b8-8782-21ebb2feee76",
"contact_id": "4f12de66-e2f1-4aa5-9420-ec5d5aa76adf",
"requested_by_company_id": "78e5e3a1-25d7-44fd-aef4-ae43e88ead6f",
"requested_by_contact_id": "d9418e32-a2c2-4918-8e31-e3b82d7c5bfe",
"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-01-19T01:30:42.9911813+00:00",
"due_date": "2026-01-19T01:30:42.9911813+00:00",
"date_create": "2026-01-19T01:30:42.9911813+00:00",
"date_update": "2026-01-19T01:30:42.9911813+00:00",
"date_closed": "2026-01-19T01:30:42.9911813+00:00",
"suggested_user_id": "a91bf4b3-f8c4-4053-bf40-bc9e8064e312",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1cd840e3-d366-4076-9f2c-47095ee28791",
"db_language_id": "5f61aa70-485c-46a6-9791-95147efa2054",
"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-01-19T01:30:42.9911813+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b3874224-7311-4f72-bcf7-8f2749abb077",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "87306a3b-3e87-4d60-9c84-b3d65660bb33",
"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": "0d827153-6cbb-4d9b-8f18-358b44234c0e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "eec8b1ed-1a3a-4b9f-90ee-4e120d48bc7c"
},
"suggested_date_start": "2026-01-19T01:30:42.9911813+00:00",
"skill_id": "f7d28bd8-211f-4430-9877-5c9281cd0342",
"skill_code": "sample string 32",
"skill": {
"id": "1304f394-6f05-49b9-a1c9-b572e15cfdb1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4114552b-d993-4631-9fea-72bc1de33e99",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ae60ac97-d055-4261-917e-6d6b05b2c51e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e3ff386e-5a9e-4842-948e-24e91c95b165",
"db_currency_id": "fb9c156c-6148-4e20-a5a5-5e7f251e16b3",
"db_language_id": "0d136cd3-e53a-444e-a168-ed6e7ba1607e",
"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-01-19T01:30:42.9755571+00:00"
},
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "5bcd5a6e-390c-4531-ad1b-34e50f856032",
"date_reported_by_company": "2026-01-19T01:30:42.9911813+00:00",
"id2": 36,
"company_id": "190f2c22-62b3-4f9d-8cb0-021458a40387",
"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": "248c811e-57bd-435f-ad6b-574703a0bb52",
"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-01-19T01:30:42.9911813+00:00"
},
"work_instruction_details_id": "c814283d-51f2-4aab-8176-c2b1f72ac949",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f97c925c-ecc5-4050-9a45-806778a3b731",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "f273e19f-0506-4e3f-9686-50b716e6b31e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T01:30:42.9911813+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": "853b3b36-0fed-4c0e-b176-4c0095170b5b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T01:30:42.9911813+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.