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": "0b476a17-ac3a-4797-bddc-a953f7a666e9",
"jobs_id": "5bc7a854-c238-4e68-bc4a-15adaf673ec0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "6a0ef83b-f732-4816-8f12-0cd706d2b425",
"_parent_id": "74c99b4b-c2d3-426b-b64a-6f80d13c953b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "22cb5d6c-7200-439f-ba5e-c20bce8f2b5b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "89177505-bf80-49bb-9b35-edd16ee911aa",
"_parent_id": "11294e50-63ff-47c3-8279-29bd305bdec0",
"root_parent_id": "c47189fa-4cdd-4cf6-bad4-b642a20cdbbb",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "089af436-f9fe-4715-9a33-0f65dc4af9d0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7ff5fb6f-577d-4630-8cef-8182dc759cca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f4b1fc26-82d5-450a-9de9-8aa141ff8373",
"_parent_code": "sample string 6",
"sales_organization_id": "aaa07b64-0e8b-4723-9f43-05e7046da223",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"equipment_model_id": "4b430eed-c26f-46b2-b75d-1cbad8262c6f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ba4ed91e-19ac-49a0-85a5-7e147343a855",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "109bf360-dcb2-4a58-8f9c-7e7930a80312",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "81812529-f38b-4b25-8441-a3aedea4df46",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a70e40ef-1b36-4204-b4e1-cfb2fd15aa75",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"equipment_family_id": "bdcd10de-7bd0-41d9-9a5f-212cc4b2c01c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7ff5fb6f-577d-4630-8cef-8182dc759cca",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f4b1fc26-82d5-450a-9de9-8aa141ff8373",
"_parent_code": "sample string 6",
"sales_organization_id": "aaa07b64-0e8b-4723-9f43-05e7046da223",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"date_in_production_since": "2026-01-19T02:18:46.624591+00:00",
"date_out_of_production_since": "2026-01-19T02:18:46.624591+00:00",
"date_end_support": "2026-01-19T02:18:46.624591+00:00",
"sales_organization_id": "db2b73b1-35d1-4037-8ee6-49becb198b32",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+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-01-19T02:18:46.624591+00:00"
},
"project_status_id": "ee7f459a-1557-4788-a930-e74232454740",
"project_status_code": "sample string 10",
"project_status": {
"id": "52ca3c01-b730-44d6-9af8-dcc96aaa1c6e",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "102159af-7353-4518-ba52-c32f4856a25d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"company_id": "5481db8c-2d39-4e64-86a0-bb5f01ec91bf",
"company_code": "sample string 12",
"db_address_id": "7eac87be-e16e-40bc-8d38-c7e64506adde",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "89f29c89-f783-444f-aaf0-b74ab76fe689",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bd992fb8-da86-4dbb-bacf-6322cff761e3",
"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-01-19T02:18:46.624591+00:00",
"date_create": "2026-01-19T02:18:46.624591+00:00",
"date_update": "2026-01-19T02:18:46.624591+00:00",
"updated_by_user_id": "c6fafc59-4416-4477-bfbd-d7349bd71fc4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-19T02:18:46.624591+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-01-19T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-19T02:18:46.624591+00:00",
"date_last_job": "2026-01-19T02:18:46.624591+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-19T02:18:46.624591+00:00",
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00",
"is_mobile_installation": true
},
"job_type_id": "14a21238-4392-434c-aba3-7389a4182667",
"job_type_code": "sample string 7",
"job_type": {
"id": "69c7cce0-8a7f-401f-bdda-79ae86aa21f3",
"name": "sample string 2",
"sales_organization_id": "a338bd14-e3f1-47a3-bb4e-5cd2446e6487",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d8182d0-bfc2-4203-b189-409a4733723a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a4210d8b-ef86-401c-8353-503568866fad",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "55801eda-8b6f-4540-9d69-99c06d7f6b80",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"job_status_id": "5d25d690-79e6-4a47-8498-def26265b6cb",
"job_status_code": "sample string 11",
"db_address_id": "e322ea2c-2137-4f03-8905-030dad8c493e",
"contact_id": "8eb1e15a-3a1c-47e1-a5a0-399fd2c28abb",
"requested_by_company_id": "9112aaff-4651-40fd-95aa-d4ccd0be7145",
"requested_by_contact_id": "92410776-d4e2-44a1-8e45-5b511f6a100d",
"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-01-19T02:18:46.624591+00:00",
"due_date": "2026-01-19T02:18:46.624591+00:00",
"date_create": "2026-01-19T02:18:46.624591+00:00",
"date_update": "2026-01-19T02:18:46.624591+00:00",
"date_closed": "2026-01-19T02:18:46.624591+00:00",
"suggested_user_id": "0ea49107-c67f-418c-9255-9e68838ca03d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2220f499-730b-41a2-87f5-1d4d706da5e0",
"db_language_id": "a9026755-4c4b-47c3-b652-4b93825d8d51",
"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-01-19T02:18:46.624591+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6401e778-d234-4b2d-ad76-b58cf29886ba",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2f5696e8-25e4-4092-9e27-8a205b3e7d44",
"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": "88e17aff-904c-4889-b1d2-fa74017b85ae",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3b806dfb-ae8a-4bbb-bc3d-45a1ab5e789e"
},
"suggested_date_start": "2026-01-19T02:18:46.624591+00:00",
"skill_id": "b4993e4e-2570-4ddd-a62d-af07bde39fb2",
"skill_code": "sample string 32",
"skill": {
"id": "240d70a4-7fb4-4e54-88d4-1740f18d8057",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "50d0e8e6-bbab-4af4-a6fe-a6f7ee3cc058",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86adf69e-5d75-4303-ae84-d47f5d60bc0c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "b0120337-1204-4f9b-add1-fa2d135dc40d",
"db_currency_id": "facb600b-a04b-468b-9ca5-a01c44b6299d",
"db_language_id": "40298a9f-ff74-49b0-8dc3-8c13b9845b09",
"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-01-19T02:18:46.6089664+00:00"
},
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "2bfbdc27-f6f1-40bd-bc0e-0ec1529ef033",
"date_reported_by_company": "2026-01-19T02:18:46.624591+00:00",
"id2": 36,
"company_id": "c817a112-389b-4635-8a3f-4f34b8590f29",
"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": "8e2f8e6b-5ec4-4b72-b3b1-6c07e8602d31",
"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-01-19T02:18:46.624591+00:00"
},
"work_instruction_details_id": "062528cd-95b8-450a-af9f-c3ababa5ce77",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4c9b29d6-69e4-4dca-91b0-ccc49aa1b1ad",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bd9d7420-4f8f-47a5-9d50-03b1039f0c97",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-19T02:18:46.624591+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": "659ef338-d3dd-4033-8fd0-662e01274909",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-19T02:18:46.624591+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.