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": "df25affe-9781-47c8-a57f-f63dc231a22a",
"jobs_id": "57ac2aae-f17b-4f03-b6ef-693e558f4a7b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "2e09e099-1b56-4c13-bde9-4ec64ac1baca",
"_parent_id": "60745e4f-f39a-4de2-9616-696e27327e54",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "a96e4f61-54ac-42df-8323-d62c276a4c56",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b34173a1-e088-4b37-bf37-67224bebfa59",
"_parent_id": "5b813150-d652-4beb-b8e9-97f422a104b8",
"root_parent_id": "18f101ee-0e8e-44e3-bd79-e843fe50b405",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "931cdc28-4ff2-4677-9f9f-44bb6da84411",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "464695c5-479e-4f34-942b-1af3769e8af8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d06b273f-0645-40de-9336-8f2ad09bc3bc",
"_parent_code": "sample string 6",
"sales_organization_id": "610ba8e5-7760-4e92-885e-a6d024a1a40d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"equipment_model_id": "e715e0c5-f67c-4b95-bdfe-d4518177a23d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "44f41368-9b55-45e0-9031-a4958dace60b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "00f96e14-ab00-462f-8930-e2ab980e4b9c",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "12fa4398-b8bc-418b-b393-aca962dd3647",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "33dc2cbe-f538-40f8-bf0d-cda3936b7028",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"equipment_family_id": "4624a08e-bb3f-4b8b-a466-86eb45bbfca2",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "464695c5-479e-4f34-942b-1af3769e8af8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "d06b273f-0645-40de-9336-8f2ad09bc3bc",
"_parent_code": "sample string 6",
"sales_organization_id": "610ba8e5-7760-4e92-885e-a6d024a1a40d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"date_in_production_since": "2026-09-28T11:05:59.0078724+00:00",
"date_out_of_production_since": "2026-09-28T11:05:59.0078724+00:00",
"date_end_support": "2026-09-28T11:05:59.0078724+00:00",
"sales_organization_id": "6a333de2-59ce-45e3-9532-d57a5af7dcc3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+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-09-28T11:05:59.0078724+00:00"
},
"project_status_id": "afcd9e55-0dc3-45d8-8b40-cca12fb36771",
"project_status_code": "sample string 10",
"project_status": {
"id": "59b2cc46-a2f7-4410-ad42-7be305f97c2b",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5b898b0e-95db-4bac-984d-032df0cd2d8f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"company_id": "0e738aef-bb1d-481e-8eff-45ffc0a91ea0",
"company_code": "sample string 12",
"db_address_id": "3af0fac3-bc23-47f6-b9a3-02fa1e827f62",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "f9d0ea1c-6590-4f14-8a39-8e78709572c6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "e46a316a-8fb1-45c6-a41d-8a1ecd1b8baf",
"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-09-28T11:05:59.0078724+00:00",
"date_create": "2026-09-28T11:05:59.0078724+00:00",
"date_update": "2026-09-28T11:05:59.0078724+00:00",
"updated_by_user_id": "f99ecf93-e37d-499f-b79d-fa09783a97a3",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-28T11:05:59.0078724+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-09-28T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-28T11:05:59.0078724+00:00",
"date_last_job": "2026-09-28T11:05:59.0078724+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-28T11:05:59.0078724+00:00",
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00",
"is_mobile_installation": true
},
"job_type_id": "1e8e32ee-6c7c-4f92-883b-2640be3ba819",
"job_type_code": "sample string 7",
"job_type": {
"id": "39a3da4b-15c2-4093-81af-6765ffa5d7dc",
"name": "sample string 2",
"sales_organization_id": "be814c69-9e7c-4e6a-97d0-e5e780fa455f",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00",
"code": "sample string 7"
},
"job_priority_id": "de19a3cf-7c0f-426e-b067-29e341b32df8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "af890d1a-ec59-4ab9-89fa-ddc3f69ae4ba",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "810e712d-5059-46ab-a07a-f13f3837abec",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"job_status_id": "c7ed3862-51a2-4c14-b74f-293bb991d947",
"job_status_code": "sample string 11",
"db_address_id": "cbfce618-bdd0-4825-830b-a7680548600d",
"contact_id": "a2cdb425-7624-443c-99f1-3d9257f435c9",
"requested_by_company_id": "17a32433-a2ac-4928-af88-93b80fd53600",
"requested_by_contact_id": "bed6a19d-6efe-4aa6-a47e-60bc24d0a36c",
"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-09-28T11:05:59.0078724+00:00",
"due_date": "2026-09-28T11:05:59.0078724+00:00",
"date_create": "2026-09-28T11:05:59.0078724+00:00",
"date_update": "2026-09-28T11:05:59.0078724+00:00",
"date_closed": "2026-09-28T11:05:59.0078724+00:00",
"suggested_user_id": "aa248309-7283-41e0-b0c7-48e9fedfc535",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fc0b6aa7-e8b8-4b9c-bb26-0314855e575f",
"db_language_id": "0fd34bbb-db09-4c39-908d-eea6b225415e",
"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-09-28T11:05:59.0078724+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "97a93dae-6c2b-4eb4-b559-3a891d01bdfc",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "9dc75d01-b7c9-4203-8816-7ba8e1b12206",
"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": "a0542cd1-f9ee-4376-b0d3-23d818b8496e",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "5b270fc6-10eb-4b47-9372-18461f69ccda"
},
"suggested_date_start": "2026-09-28T11:05:59.0078724+00:00",
"skill_id": "5ca04d6e-e723-4c33-bb39-9b1deefdd3da",
"skill_code": "sample string 32",
"skill": {
"id": "acbb6791-d22a-4edf-95dc-8293ac326db4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "662df637-59a8-4614-81f7-9878ea3145fd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "12f0483a-1a6b-4132-9efb-fc4608b183e4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7ec9c377-2169-44cd-8607-edce989cd3eb",
"db_currency_id": "a92ac823-d13c-4537-b88e-a0c22754938d",
"db_language_id": "5a9978dc-e3da-4269-976a-eebe477ebe14",
"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-09-28T11:05:59.0078724+00:00"
},
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e3359cdb-2cc9-40f3-80ca-36c2fc145da9",
"date_reported_by_company": "2026-09-28T11:05:59.0078724+00:00",
"id2": 36,
"company_id": "6f3111ed-4381-48a5-97e2-bd1f6f14be05",
"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": "9340e36b-450d-4e10-bf4e-2b94e4fee110",
"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-09-28T11:05:59.0078724+00:00"
},
"work_instruction_details_id": "a0e455fc-edb4-4389-840a-e5ce8ae115be",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "52597597-62eb-4f21-baf9-b425ec0f2f94",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "86773966-63ac-43db-b9e4-8c447f5149c6",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-28T11:05:59.0078724+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": "21b3d7fc-eb3b-4416-995a-889ee061454b",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-28T11:05:59.0078724+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.