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": "431bab7d-a80b-4bbb-a341-954e81876405",
"jobs_id": "549361e5-b82a-4b4e-853c-6518f4d6a22f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9b9c0b1d-3c3d-42ce-8425-00aee2a7c4d8",
"_parent_id": "2544de7b-ccf7-4b6f-b4af-041b35d04958",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fea37702-d658-41f0-bf2d-a01e8251f266",
"project_reference_back_office": "sample string 5",
"project": {
"id": "d5e2c848-de32-4b20-bb2c-b363dfdd0b23",
"_parent_id": "c22fec7d-f7d0-47cd-9a02-43591408fd05",
"root_parent_id": "fdbf6756-8998-478d-8422-5ec52d0f5fe3",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5bc9d438-ab1e-48ea-9a5c-55275754553f",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b85bf4b8-54be-42e4-bfa0-684b0d9bf20b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7fd4f11d-d781-4abc-9b4f-739ac4e20466",
"_parent_code": "sample string 6",
"sales_organization_id": "cae1c50e-1958-4546-b88c-421c1e8ed4f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"equipment_model_id": "a68c8728-59ce-460b-a729-cfc12e75315d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "37d05130-d28d-4321-9d47-f2b35e50ca4c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "2977cbf3-c9a7-4d3b-96b0-8f79533d0a11",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dd2d1758-c8d2-4f48-8258-a0fc701005b6",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ea0f8d2c-24ba-4f9a-92b3-2dad631516bf",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"equipment_family_id": "3cf276bb-47a6-4ce4-85d3-5e0c88d68f70",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b85bf4b8-54be-42e4-bfa0-684b0d9bf20b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "7fd4f11d-d781-4abc-9b4f-739ac4e20466",
"_parent_code": "sample string 6",
"sales_organization_id": "cae1c50e-1958-4546-b88c-421c1e8ed4f1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"date_in_production_since": "2025-10-18T15:21:11.444908+00:00",
"date_out_of_production_since": "2025-10-18T15:21:11.444908+00:00",
"date_end_support": "2025-10-18T15:21:11.444908+00:00",
"sales_organization_id": "179211e9-5a01-4e30-b443-603e991cd670",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+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-10-18T15:21:11.444908+00:00"
},
"project_status_id": "9a54228a-c346-4770-b1ae-73b3c124e2e5",
"project_status_code": "sample string 10",
"project_status": {
"id": "459ec544-c3a3-4011-9a1e-8aa4a50b8798",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "acac0eb0-72e2-4105-97dd-503f5ce3475e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"company_id": "49e36342-ebb2-4cda-b886-460b0f5776a7",
"company_code": "sample string 12",
"db_address_id": "8a18c66a-001c-4d23-857b-159a399a8cfe",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f9ef1211-87d6-4397-933c-e78f75f01c43",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "8a570a89-d212-45af-811a-411fee35fd4d",
"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-10-18T15:21:11.444908+00:00",
"date_create": "2025-10-18T15:21:11.444908+00:00",
"date_update": "2025-10-18T15:21:11.444908+00:00",
"updated_by_user_id": "86c2c226-51c4-4a58-93eb-7b8834935022",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-18T15:21:11.444908+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-10-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-18T15:21:11.444908+00:00",
"date_last_job": "2025-10-18T15:21:11.444908+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-18T15:21:11.444908+00:00",
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00",
"is_mobile_installation": true
},
"job_type_id": "ae276da3-205d-4f29-8f8a-c002329791d5",
"job_type_code": "sample string 7",
"job_type": {
"id": "1107612b-53d8-4bc0-9c75-c2823083395b",
"name": "sample string 2",
"sales_organization_id": "26062e68-ab59-4da9-886c-9c351d283d93",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00",
"code": "sample string 7"
},
"job_priority_id": "9ba3a110-bcf2-4716-91ae-dae69ab9f124",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "e1703631-5b64-4118-9e28-1fe97101bc0d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d254d48c-ec15-4116-8556-9e3986f2be39",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"job_status_id": "20c8b36e-cfb1-4da8-b5c4-9a6197c7114f",
"job_status_code": "sample string 11",
"db_address_id": "c828ca43-b599-4668-82ef-d5d2d5e39a4b",
"contact_id": "c28c04c6-0fa0-4ba5-9256-14d21482d189",
"requested_by_company_id": "6e75d499-f7df-4378-8560-b0c94638cf68",
"requested_by_contact_id": "9f2d9ce5-cefa-429d-b8e2-550901206cc2",
"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-10-18T15:21:11.444908+00:00",
"due_date": "2025-10-18T15:21:11.444908+00:00",
"date_create": "2025-10-18T15:21:11.444908+00:00",
"date_update": "2025-10-18T15:21:11.444908+00:00",
"date_closed": "2025-10-18T15:21:11.444908+00:00",
"suggested_user_id": "60d81d67-d184-4c0b-a906-652bccb8fe9e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "649ca78d-b142-452b-8456-df15602f8029",
"db_language_id": "e3e18768-381a-4cf1-ac49-6f8d1c1485e6",
"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-10-18T15:21:11.444908+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "21fec9f2-f510-41cb-a5bf-4dba233ebe50",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2efc70ea-ee32-4bf9-927e-fb385a80fa32",
"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": "6300e685-a46b-4c48-8bb1-ecfe814860b5",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6826b9b5-7041-4be3-b3b4-c5dcd373fc0c"
},
"suggested_date_start": "2025-10-18T15:21:11.444908+00:00",
"skill_id": "f87ad1d6-1a30-4850-9e33-9eda79c7b063",
"skill_code": "sample string 32",
"skill": {
"id": "bb5c4941-76cc-4a79-9b1b-1da4de6ec20b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "7cdd2741-9f62-4b7a-86df-2cc0e667a10d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "2f01fdc9-ff8d-4df2-ba1c-878a8511f61f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "a8512f22-f4f3-415a-b63b-dee62b0796ab",
"db_currency_id": "b4218468-9bda-4c52-99c2-dd23d323f676",
"db_language_id": "ccb4fa1e-a71c-49d2-ba83-254f816e875d",
"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-10-18T15:21:11.444908+00:00"
},
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7cfa59b8-81f0-49e3-be04-7a187430b0e0",
"date_reported_by_company": "2025-10-18T15:21:11.444908+00:00",
"id2": 36,
"company_id": "442d65e4-6e84-402c-a67f-3a0eeca4f6f3",
"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": "f19b53ff-a808-4f14-ada7-5e6bd7f76209",
"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-10-18T15:21:11.444908+00:00"
},
"work_instruction_details_id": "1a80cde3-b7c4-49e2-991f-687029354019",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ab6a78ef-f3b7-4fd6-8539-4ef6bf3073fd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3bdfd8ef-310a-4fb4-a61c-4a2ac6c5b996",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-18T15:21:11.444908+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": "ef74e98b-4480-432f-b5e0-ffd75f28777f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-18T15:21:11.444908+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.