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": "cbec933b-c1bc-4448-884b-405fd901395a",
"jobs_id": "10ad1320-0a3d-4482-ac1b-4a05a86f6c90",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "e66ab39e-d0a0-481f-abdb-e3934ce9ba55",
"_parent_id": "0203c48b-85cd-49b3-82dd-57a250c54e50",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "6bc514dc-6805-4d03-aacc-800f65563179",
"project_reference_back_office": "sample string 5",
"project": {
"id": "7b3b0aad-3e46-4c55-8d8d-6b2dc44f3d1f",
"_parent_id": "65636744-cd9a-4505-92f0-2422973ce7b8",
"root_parent_id": "11e7256d-ad32-4080-b6ec-3139a648155f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "92ca0491-c1b8-4c5e-a5b3-b79a8619fc0c",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7694bfbf-9f48-4f5c-a0a0-7e2b930a8840",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3f856a89-09aa-498c-b293-b912155be213",
"_parent_code": "sample string 6",
"sales_organization_id": "1e1a3415-ce2f-4899-a036-c7f54af74f0b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"equipment_model_id": "1e5bce8d-3fb0-4e17-85bd-019345a08673",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "bf085b3a-ec75-4928-961c-f81afda2bb74",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6189ccb3-f572-4cd2-871e-f9bb7a632e54",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a9c20a73-21c2-43e7-86b2-5f96095e1765",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "59e22369-b21e-4cea-847b-27cad61a2e03",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"equipment_family_id": "751bffd0-a687-453f-98eb-811452bd9358",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7694bfbf-9f48-4f5c-a0a0-7e2b930a8840",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "3f856a89-09aa-498c-b293-b912155be213",
"_parent_code": "sample string 6",
"sales_organization_id": "1e1a3415-ce2f-4899-a036-c7f54af74f0b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"date_in_production_since": "2026-08-14T04:29:17.7088665+00:00",
"date_out_of_production_since": "2026-08-14T04:29:17.7088665+00:00",
"date_end_support": "2026-08-14T04:29:17.7088665+00:00",
"sales_organization_id": "1934da6d-1fec-41ee-a4c1-d57c1467b2fc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+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-14T04:29:17.7088665+00:00"
},
"project_status_id": "f7238e50-5f6c-43d5-a7cb-42defb65b82e",
"project_status_code": "sample string 10",
"project_status": {
"id": "f4b7850a-4eb5-4206-97d5-0cdfd466ae74",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "88f94216-bf13-4425-b05c-ad67621b199e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"company_id": "8cbd87bb-9acf-4585-855f-4428f30cb783",
"company_code": "sample string 12",
"db_address_id": "3dc2c67f-659e-4b8b-a933-1aefaeecc860",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "11795a47-32cc-460a-9562-a2d0de7872c8",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "111ef31e-c197-45ad-846e-0f889339e8bb",
"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-14T04:29:17.7088665+00:00",
"date_create": "2026-08-14T04:29:17.7088665+00:00",
"date_update": "2026-08-14T04:29:17.7088665+00:00",
"updated_by_user_id": "1f098822-331c-49c1-9b5b-9ec0c00a5b23",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-14T04:29:17.7088665+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-14T04:29:17.7088665+00:00",
"date_last_job": "2026-08-14T04:29:17.7088665+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-14T04:29:17.7088665+00:00",
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00",
"is_mobile_installation": true
},
"job_type_id": "8fb1c297-0f25-4504-8871-bdd119ff380e",
"job_type_code": "sample string 7",
"job_type": {
"id": "dfc928b5-375a-41ca-8f8d-67a7379a2211",
"name": "sample string 2",
"sales_organization_id": "82e97ff0-4508-4206-9e0c-0099a937c973",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00",
"code": "sample string 7"
},
"job_priority_id": "6b9ba069-ffb3-49bb-86a2-8c291868bd9d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "77595685-cba7-48af-956b-04d1b9daf38f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c872b7e2-144d-4b72-ac77-f5354a64e83e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"job_status_id": "76383057-d48f-4b46-8971-0a931cd505fc",
"job_status_code": "sample string 11",
"db_address_id": "e976d248-d108-487e-a47c-16f68ce4bfc9",
"contact_id": "2be532b1-e8be-4b61-be58-43e4c4f9e3d2",
"requested_by_company_id": "31609b8d-ab73-4072-a749-aa881f2347ea",
"requested_by_contact_id": "626e4029-66d6-4a13-bdea-5ac2aead9535",
"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-14T04:29:17.7088665+00:00",
"due_date": "2026-08-14T04:29:17.7088665+00:00",
"date_create": "2026-08-14T04:29:17.7088665+00:00",
"date_update": "2026-08-14T04:29:17.7088665+00:00",
"date_closed": "2026-08-14T04:29:17.7088665+00:00",
"suggested_user_id": "a15ea1b4-0b71-47d2-b486-04b100db0a4b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fbdc3ea3-fde0-4ebb-9c05-1fdea144e1b2",
"db_language_id": "c9b3c1aa-9d66-40c5-9929-274e2e07ad5a",
"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-14T04:29:17.7088665+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f8fe23d8-167e-4d04-9a99-b8f96a485807",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ea02a87c-976d-4d10-95cc-9707e78ae379",
"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": "7a7d0ddf-91f1-4e5a-a69f-8e95b9878b90",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8b644afb-37eb-450d-9a44-6b595ee0c6e7"
},
"suggested_date_start": "2026-08-14T04:29:17.7088665+00:00",
"skill_id": "53fbf579-4ed7-48c6-bc6a-743349a657fc",
"skill_code": "sample string 32",
"skill": {
"id": "59a3f8d1-9dde-45b1-8cb3-e57a914e6b2b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "89050424-3907-4f8d-8993-c6133a40ba7d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eb516dae-5a51-424b-9468-8c5ab6346ec1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "82543092-4d1f-48f9-b1f4-2a2e4f3d0cf1",
"db_currency_id": "e2eb93e5-de47-4474-82eb-1a9b0f714015",
"db_language_id": "f32eec4b-deab-4c97-9621-2c09e4807185",
"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-14T04:29:17.7088665+00:00"
},
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3224dce0-3971-4558-9275-b3e57bbb40f6",
"date_reported_by_company": "2026-08-14T04:29:17.7088665+00:00",
"id2": 36,
"company_id": "84872e8c-d603-40b1-8540-927ba23216d6",
"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": "d1d9ba36-2948-4a55-ad24-16bd20940334",
"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-14T04:29:17.7088665+00:00"
},
"work_instruction_details_id": "3ab44ffe-1356-43e4-99f6-ccf62a488b71",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "a77ec71b-da06-47e9-b008-1b35d5f2ac66",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4c2bc9ba-b171-4706-8d87-ceaf4924256a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-14T04:29:17.7088665+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": "a15bfd12-3a45-491a-ab33-523b5df24876",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-14T04:29:17.7088665+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.