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": "e143a41a-e43d-4447-835e-78bf4182e247",
"jobs_id": "555b873c-595f-46b7-a2e6-65a1198b5aab",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "20a138bb-19bd-461e-8f74-6edc61bc2477",
"_parent_id": "b1c69bff-30c1-4ea5-a0b3-21f671cfec11",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "79afe1cd-61a1-4a60-a3a1-5b89b2827045",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d413cff1-bc14-49dc-93da-82cf019d3c80",
"_parent_id": "ccac3e4b-3a27-4fa8-859c-de64a96a0e95",
"root_parent_id": "0615538c-2d25-49d1-ba77-7ab9d9c41cd7",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "395765d6-189d-413b-b886-3df5a62914b8",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "5ae120af-d5f7-4cb1-a5c3-6547ee8a88c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ed90b42-cef2-4604-af5b-2cce25723227",
"_parent_code": "sample string 6",
"sales_organization_id": "829ac681-4093-494a-b354-875a191f4160",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"modified_dateutc": "2026-10-02T01:31:45.2375699+00:00"
},
"equipment_model_id": "9356a11f-c482-4649-a2c4-bb9f3fba2259",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "68f43c0a-2ef3-47d5-b488-7961e47c273a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8d6397e5-7274-48ec-a217-5c488841d12d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9f4dab76-a7e6-4e41-9f71-473c4978e760",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "d0589174-0857-42bf-9b7c-4115804e30d4",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"modified_dateutc": "2026-10-02T01:31:45.2375699+00:00"
},
"equipment_family_id": "b4e6fba1-72c2-4d8a-b644-6b81cc6cf2ff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "5ae120af-d5f7-4cb1-a5c3-6547ee8a88c7",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7ed90b42-cef2-4604-af5b-2cce25723227",
"_parent_code": "sample string 6",
"sales_organization_id": "829ac681-4093-494a-b354-875a191f4160",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"modified_dateutc": "2026-10-02T01:31:45.2375699+00:00"
},
"date_in_production_since": "2026-10-02T01:31:45.2375699+00:00",
"date_out_of_production_since": "2026-10-02T01:31:45.2375699+00:00",
"date_end_support": "2026-10-02T01:31:45.2375699+00:00",
"sales_organization_id": "d8712852-d34a-4c0a-a3d1-cdf46e120ac1",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+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-02T01:31:45.2534546+00:00"
},
"project_status_id": "d923e0f5-bdab-4ea3-b3ec-c8de7f1a91d1",
"project_status_code": "sample string 10",
"project_status": {
"id": "26e9a1f8-e650-4971-9707-91984dd69f1a",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "43cafca7-a1fd-40a7-a06a-e26de7ad83ff",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00"
},
"company_id": "63f93b6a-c14b-4620-a706-5908694e770d",
"company_code": "sample string 12",
"db_address_id": "6909be5f-f437-4d57-8a00-e165d9176f52",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "db9a8da9-3589-4109-8a19-4cffe33114da",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "737be98f-7993-4d00-ad7b-c1aa7961b1ed",
"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-02T01:31:45.2534546+00:00",
"date_create": "2026-10-02T01:31:45.2534546+00:00",
"date_update": "2026-10-02T01:31:45.2534546+00:00",
"updated_by_user_id": "7871132d-752d-4fb8-8b49-f8c04af7650b",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-02T01:31:45.2534546+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-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-02T01:31:45.2534546+00:00",
"date_last_job": "2026-10-02T01:31:45.2534546+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-02T01:31:45.2534546+00:00",
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00",
"is_mobile_installation": true
},
"job_type_id": "c7126762-d321-474c-9349-5c32b98079a9",
"job_type_code": "sample string 7",
"job_type": {
"id": "fd9b6d76-38fe-4b8a-8b70-a758411c90f1",
"name": "sample string 2",
"sales_organization_id": "5ce3681c-212d-4a31-94f7-6099b1546fc6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00",
"code": "sample string 7"
},
"job_priority_id": "ccf9d3ad-24f3-4721-89fc-91eb1808b056",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0bc1e095-9bb3-4a21-989c-bd2fca9066b4",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6a6d03c7-0712-4368-9ae0-29a49868b200",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00"
},
"job_status_id": "bb00d25c-532c-4d72-9879-89991a2e154c",
"job_status_code": "sample string 11",
"db_address_id": "0d15bcce-662c-48db-aa7c-d6652197146a",
"contact_id": "3aed30dd-7c3d-439c-a88e-13e5133f700d",
"requested_by_company_id": "6cf2ecf6-71d9-426b-b8e4-ee006e146a14",
"requested_by_contact_id": "a9c39474-1a7e-4c41-af78-25e2bccf7eec",
"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-02T01:31:45.2534546+00:00",
"due_date": "2026-10-02T01:31:45.2534546+00:00",
"date_create": "2026-10-02T01:31:45.2534546+00:00",
"date_update": "2026-10-02T01:31:45.2534546+00:00",
"date_closed": "2026-10-02T01:31:45.2534546+00:00",
"suggested_user_id": "403f2245-7d87-4ee2-a11b-af25378c63d1",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8a6cc649-1775-41f5-8caf-2cdc3dbc9437",
"db_language_id": "93ff06f7-a544-425b-adc0-db5f9c5c6cb4",
"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-02T01:31:45.2534546+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cb5f930b-b557-4d9f-8841-296d7389b283",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9c3ab6aa-9c0a-478e-975b-b05c31929586",
"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": "453152ee-157d-4b17-8642-2f2e182a0161",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8b100481-7bc4-4972-a1ec-ab2008e015d2"
},
"suggested_date_start": "2026-10-02T01:31:45.2534546+00:00",
"skill_id": "679ca86c-c441-4164-8129-d81d1d6efd9a",
"skill_code": "sample string 32",
"skill": {
"id": "303d38e0-a75c-4378-8008-2f4675b155d3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "31dccc61-9992-4cb1-beaf-4ba4100d1f65",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "9085d683-a58e-4ec1-ac05-4fea451b97bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "2f5acc4d-a3a7-4543-87e7-737c925c54db",
"db_currency_id": "2aecae59-30d8-4699-bfd3-9f7aaddeaa6c",
"db_language_id": "6f735847-bbec-4a74-9713-c85cdf212b78",
"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-02T01:31:45.2375699+00:00"
},
"modified_dateutc": "2026-10-02T01:31:45.2534546+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1c469825-71e1-430e-8560-ff1e42c2db0f",
"date_reported_by_company": "2026-10-02T01:31:45.2534546+00:00",
"id2": 36,
"company_id": "d71d32fb-10b4-42dc-a1fa-af3466d72b6d",
"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": "a693f5b8-5352-4ea2-a9d3-7081fc0449be",
"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-02T01:31:45.2534546+00:00"
},
"work_instruction_details_id": "3ded5032-8564-4e17-bc0f-4cf747675382",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f86612b8-8d3a-455f-92e5-7bc1e641b993",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "75d9421a-dfd7-4e39-afb9-235f21e302ae",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-02T01:31:45.2534546+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": "0b9b0b21-5d03-4e16-bff7-69337c2bb928",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-02T01:31:45.2688208+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.