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": "b6bd04d3-603f-4f44-b836-33c665c5d401",
"jobs_id": "12cc0600-7c3e-4703-8d00-912e1bf7263d",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5ff5da4f-436d-4c65-9395-dbe00e916ca3",
"_parent_id": "90e29110-bf75-4963-b4d1-27e8d72caafb",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ddc6a9a6-cfc5-42f8-b099-a49831e0a680",
"project_reference_back_office": "sample string 5",
"project": {
"id": "29e0a378-a0af-442a-b54a-3d2dd18db826",
"_parent_id": "19215680-0959-44d8-9ff1-32fff5e72349",
"root_parent_id": "27b57a59-ecf6-4aa0-a158-c769db8cabbe",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "6d9c1aae-96ab-4198-9cc3-eac12bc7f89e",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f3c3c1d4-7ab2-422e-9770-2aac13a2f43c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b7f5a53a-040f-4187-bace-99be158e78a1",
"_parent_code": "sample string 6",
"sales_organization_id": "4f6a9a24-e05d-440e-91cf-96663b613acb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"modified_dateutc": "2026-10-21T05:33:57.3383698+00:00"
},
"equipment_model_id": "a1a2cd03-6d2f-4bc4-b460-9982ba7cb415",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "06edd12a-7e7b-4363-8830-f3dc67b2ecf8",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1a1382cf-703e-409c-ae5d-c3dad69cb0f6",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9705b3b5-e6f6-49cc-ae97-c69a881aacfe",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3b2f1ba3-46cb-4202-af9f-2efbcfd97404",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"modified_dateutc": "2026-10-21T05:33:57.3383698+00:00"
},
"equipment_family_id": "7746758e-c8a2-4c75-b47a-0d056fbdbda0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f3c3c1d4-7ab2-422e-9770-2aac13a2f43c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b7f5a53a-040f-4187-bace-99be158e78a1",
"_parent_code": "sample string 6",
"sales_organization_id": "4f6a9a24-e05d-440e-91cf-96663b613acb",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"modified_dateutc": "2026-10-21T05:33:57.3383698+00:00"
},
"date_in_production_since": "2026-10-21T05:33:57.3383698+00:00",
"date_out_of_production_since": "2026-10-21T05:33:57.3383698+00:00",
"date_end_support": "2026-10-21T05:33:57.3383698+00:00",
"sales_organization_id": "bf760c89-085f-4f0d-abbb-014fa01199bc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+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-21T05:33:57.3383698+00:00"
},
"project_status_id": "2012ec90-00c7-4aff-88d3-44c5f79d4088",
"project_status_code": "sample string 10",
"project_status": {
"id": "8a2844a6-e2b9-4ae1-a3a5-56d66dff65dd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e28c11b9-dfeb-4cbf-9538-7a1c2080767b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T05:33:57.3383698+00:00"
},
"company_id": "d53bad95-0098-408e-8afc-23a9f0c81104",
"company_code": "sample string 12",
"db_address_id": "7e5f9729-1125-464f-bbdf-62bb1a791067",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "86d3d034-e10b-4511-aaff-5ae736047fcf",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7ebb59c8-8d85-432c-9a5f-8f0fb6965e4f",
"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-21T05:33:57.3586096+00:00",
"date_create": "2026-10-21T05:33:57.3586096+00:00",
"date_update": "2026-10-21T05:33:57.3586096+00:00",
"updated_by_user_id": "9ee25c39-8bf1-4ee2-8d6d-d4b277d71e66",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-21T05:33:57.3586096+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-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-21T05:33:57.3586096+00:00",
"date_last_job": "2026-10-21T05:33:57.3586096+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-21T05:33:57.3586096+00:00",
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00",
"is_mobile_installation": true
},
"job_type_id": "3d6118a1-e7be-4f47-965e-3f9331631455",
"job_type_code": "sample string 7",
"job_type": {
"id": "42ba223b-5368-4ede-bd36-597658306554",
"name": "sample string 2",
"sales_organization_id": "20022afd-1db7-4f65-b1f0-bb639e4f475c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00",
"code": "sample string 7"
},
"job_priority_id": "b822f30c-3d46-4796-91c4-0d6be1fefc3c",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "5d964cd2-8b77-451c-8834-266144733902",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "43615027-bafe-4547-bbb8-df6534312848",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00"
},
"job_status_id": "7b0fc7a2-0c9b-4f69-8ef3-154439bcbb85",
"job_status_code": "sample string 11",
"db_address_id": "9690628e-f99e-4299-9989-98286ad16a92",
"contact_id": "38f74f6a-4c20-4e1b-afaa-a1d7cf8680f4",
"requested_by_company_id": "9a239984-436f-42d0-ba8d-f84c7bcf940e",
"requested_by_contact_id": "6002adeb-bfd8-4fae-95da-7c23ad091435",
"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-21T05:33:57.3586096+00:00",
"due_date": "2026-10-21T05:33:57.3586096+00:00",
"date_create": "2026-10-21T05:33:57.3586096+00:00",
"date_update": "2026-10-21T05:33:57.3586096+00:00",
"date_closed": "2026-10-21T05:33:57.3586096+00:00",
"suggested_user_id": "8fae5097-5693-4e3f-838e-10a3fc9e759e",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "e3cc339a-e41c-4dac-8075-c21c408c5548",
"db_language_id": "ea68b1be-4acc-4b36-a09e-7b0852a8fbaa",
"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-21T05:33:57.3586096+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "40745649-e3d0-4029-8b0e-6353333dd0ae",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "26819824-7662-41df-a064-f7e6f5822d5d",
"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": "e512e2e2-9acb-4e14-8dc7-9cfe7d69ad4a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d1e71b3f-a195-4cc8-b6c0-e7df4437630f"
},
"suggested_date_start": "2026-10-21T05:33:57.3586096+00:00",
"skill_id": "802e4fac-83ca-4c37-aa5e-0b6658524f5e",
"skill_code": "sample string 32",
"skill": {
"id": "e3abec34-d7fc-4996-a92f-fb34d5ecd459",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8c7e4f31-2710-4498-9a7c-c793fdae6369",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "698af6d1-4601-4482-8b90-ca5d530014bd",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c96af5a9-45df-4f65-a685-c20c57a5058d",
"db_currency_id": "588a5ee9-42e5-4a2f-9614-c82d325ea3e1",
"db_language_id": "d4c60396-4c75-4f7e-81cd-3f83522eae4e",
"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-21T05:33:57.3383698+00:00"
},
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "3612bc13-fd94-4c54-89b0-d2c0ba4dcedc",
"date_reported_by_company": "2026-10-21T05:33:57.3586096+00:00",
"id2": 36,
"company_id": "915ce2ef-5742-453b-9d28-87da107b820e",
"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": "cf7e767d-b9bf-4635-9cbb-398595788b0b",
"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-21T05:33:57.3586096+00:00"
},
"work_instruction_details_id": "f31af607-f171-42e7-860f-d562f97f55f9",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b406b971-ada9-49e5-af57-424bcfed53f5",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "8225fe9f-b4e2-4cce-8e57-87f89ef529e7",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-21T05:33:57.3586096+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": "5f2622bd-1155-4b9e-8e60-8cfc7d50cb02",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-21T05:33:57.3586096+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.