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": "4739d373-4cbf-4461-848b-be2f4a3b94ef",
"jobs_id": "9ce40d21-640c-4f19-a0d7-8e20a0181bda",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e0903e39-8c7a-423b-a0c3-7085aa990fa4",
"_parent_id": "5b6da5e4-9421-46b4-8b63-90d6bc8c85bf",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "b68f7f8c-2a07-4656-808f-f1d47a7c8277",
"project_reference_back_office": "sample string 5",
"project": {
"id": "02068fa2-b220-4a18-95e2-0d36533afaf4",
"_parent_id": "ed75e375-7b15-4cfd-8de1-25e7eee276f2",
"root_parent_id": "89d502fe-7844-43bc-b425-d3dcf7170f23",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "0027af9b-07e2-45be-be86-24aa600fd548",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "48c18ab4-b14c-4e2a-b006-714ed6e83885",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99c88ed0-a06c-4f69-9122-8734a5f86b64",
"_parent_code": "sample string 6",
"sales_organization_id": "856f730e-793a-4019-acf0-222525f8aa0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"equipment_model_id": "085c65af-bd25-435c-ad3a-62e2abe7b459",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "641247e9-95b0-445b-bb76-e8675387ed07",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "233b3d7b-7d89-4585-a48f-ac35e04d2569",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "b77ad6c2-a8a3-4127-9610-e585a52afd93",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "833ed95b-9e2e-478f-acb9-213491608cb7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"equipment_family_id": "d33749f5-2ecb-4039-8340-9340fbdaf0bd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "48c18ab4-b14c-4e2a-b006-714ed6e83885",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "99c88ed0-a06c-4f69-9122-8734a5f86b64",
"_parent_code": "sample string 6",
"sales_organization_id": "856f730e-793a-4019-acf0-222525f8aa0e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"date_in_production_since": "2025-12-30T04:20:17.1191692+00:00",
"date_out_of_production_since": "2025-12-30T04:20:17.1191692+00:00",
"date_end_support": "2025-12-30T04:20:17.1191692+00:00",
"sales_organization_id": "3f93624d-0f72-4efb-83a5-3fe083d27f7a",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+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": "2025-12-30T04:20:17.1191692+00:00"
},
"project_status_id": "1d93e98c-e600-406d-aa09-29032e5f8f5f",
"project_status_code": "sample string 10",
"project_status": {
"id": "c13529d4-fac0-4f9a-940e-b1d4408566ac",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "602fe8ec-20db-40fc-b574-f2aafcc5bd1d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"company_id": "ab413b18-d036-42d0-b024-4bd1c9b6c880",
"company_code": "sample string 12",
"db_address_id": "d88cb40c-190b-43c6-b2d3-a428cd742473",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "976b4239-874b-4f16-8a64-b97d23d2c025",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "802b5afa-627d-4f2d-a86c-b3f00c6735f0",
"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": "2025-12-30T04:20:17.1191692+00:00",
"date_create": "2025-12-30T04:20:17.1191692+00:00",
"date_update": "2025-12-30T04:20:17.1191692+00:00",
"updated_by_user_id": "d21891e0-9ee1-4e1a-a15b-39ddef560201",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-12-30T04:20:17.1191692+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": "2025-12-30T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-12-30T04:20:17.1191692+00:00",
"date_last_job": "2025-12-30T04:20:17.1191692+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-12-30T04:20:17.1191692+00:00",
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00",
"is_mobile_installation": true
},
"job_type_id": "6dd196e1-1089-40b1-8504-1eb33a2bdf0a",
"job_type_code": "sample string 7",
"job_type": {
"id": "0b77299a-4aba-4197-a37c-a52b63b0f311",
"name": "sample string 2",
"sales_organization_id": "46707bf1-057f-41a4-aed9-373bbb916747",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00",
"code": "sample string 7"
},
"job_priority_id": "8f02154c-8a10-4e4e-9407-3b5e9f0e8659",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "c70c9c98-36e8-4543-9e0a-0b905e61298c",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "79b0ded6-1e41-43cc-bcab-3051412b2017",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"job_status_id": "541dcf90-618a-47ec-b972-3f42fa87dda6",
"job_status_code": "sample string 11",
"db_address_id": "c0f8c179-58e6-4219-9f5d-37fa2e6a6755",
"contact_id": "b5efc77d-f6b1-44fe-8455-0cb170b51492",
"requested_by_company_id": "ef22b6e2-57ef-41ac-9c4f-0b49a67d96ee",
"requested_by_contact_id": "8957cefa-432c-4e57-9e52-5c8f8265b990",
"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": "2025-12-30T04:20:17.1191692+00:00",
"due_date": "2025-12-30T04:20:17.1191692+00:00",
"date_create": "2025-12-30T04:20:17.1191692+00:00",
"date_update": "2025-12-30T04:20:17.1191692+00:00",
"date_closed": "2025-12-30T04:20:17.1191692+00:00",
"suggested_user_id": "48b62a17-4020-4e5d-b1ae-b7dcf3df1836",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "3df40df0-e338-4572-bc34-277a75b1f486",
"db_language_id": "29fb2ca8-762c-425f-a537-d68954b7335a",
"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": "2025-12-30T04:20:17.1191692+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "1136df12-4615-4a28-b334-ac1d88c678d4",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d45b6d95-db04-4e98-92b9-f0f2714eb9d2",
"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": "4f5fac49-9f8b-43ec-8d30-e1b4a4367f63",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "17d2d868-4834-440e-bb1f-6455ca4e622b"
},
"suggested_date_start": "2025-12-30T04:20:17.1191692+00:00",
"skill_id": "3ea22f74-befc-4004-bc23-967144ef3df9",
"skill_code": "sample string 32",
"skill": {
"id": "2f032d40-77e6-4398-a593-43400271a8a0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "48ce225d-0cb5-4873-b3c9-a2d616e9f760",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4dca7768-4376-4ecc-b720-e75740609959",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6ecd6fe3-d869-454a-9761-6d8376c3fc70",
"db_currency_id": "dbcc0a9f-5856-4348-8f4e-da6ebe26797f",
"db_language_id": "b66cb16d-2670-4f90-8ec7-48fc50fbdb30",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "35964028-ec7f-486c-b8b7-b991242ff718",
"date_reported_by_company": "2025-12-30T04:20:17.1191692+00:00",
"id2": 36,
"company_id": "05079f41-3c55-4a09-a2b5-4c1bd7745534",
"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": "adc2bee2-3033-4e33-9ba5-099fca0aaa6b",
"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": "2025-12-30T04:20:17.1191692+00:00"
},
"work_instruction_details_id": "8e3d95a8-ead4-46fc-9d8f-0175846aa24d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "22969231-c1d8-4e13-a0cd-f588d96df959",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "97ff6701-bcb7-401e-8de6-c792aad3d292",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-12-30T04:20:17.1191692+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": "b8052413-f434-46d8-9b8e-12a2facbf227",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-12-30T04:20:17.1191692+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.