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": "27b2c996-20f5-4bb5-a870-f87e37dc7c62",
"jobs_id": "fc6bc569-46f3-46f2-bdb8-a8747a2e438a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b8438afb-40cb-4c10-b2d9-b616e74ea5f9",
"_parent_id": "096e1a68-e75b-44b4-b709-0782ca42580d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "66672185-9d5f-4257-bb53-c2c4be814a54",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f16b1856-cd0c-4baf-a96b-30ca5d682e65",
"_parent_id": "5390e006-54dd-4081-bed3-78861a24ae33",
"root_parent_id": "6c1d4df7-b216-4f78-b178-773b7573df7e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "e19c7fd4-14ae-451c-81fd-e7cadf4b5468",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "47b9f0be-3e0c-4a39-b2c0-20c126569980",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "978e56a8-35f0-47dd-95a8-062f65b15c80",
"_parent_code": "sample string 6",
"sales_organization_id": "a25ac825-f52b-4b4e-87e9-64e6792c4b22",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"equipment_model_id": "213ccd8b-5f53-4d35-a6b1-fd61ae70da3c",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "97bee45e-f418-431c-8645-9eb345f000af",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ba7a19d3-9b2c-40e7-b070-4ccd2582bf90",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "089ff851-110d-4cd1-8769-1481a7ac967e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "6bc95ade-3590-468e-b94b-78b8d868c1dd",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"equipment_family_id": "ecc3b1ff-12df-4471-afbe-51551cd248f4",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "47b9f0be-3e0c-4a39-b2c0-20c126569980",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "978e56a8-35f0-47dd-95a8-062f65b15c80",
"_parent_code": "sample string 6",
"sales_organization_id": "a25ac825-f52b-4b4e-87e9-64e6792c4b22",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"date_in_production_since": "2026-09-18T21:23:17.1141622+00:00",
"date_out_of_production_since": "2026-09-18T21:23:17.1141622+00:00",
"date_end_support": "2026-09-18T21:23:17.1141622+00:00",
"sales_organization_id": "1a2deb35-dc4d-47c3-a17e-eec3aa756402",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+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-18T21:23:17.1141622+00:00"
},
"project_status_id": "4d21fbc3-9404-4000-95b4-4822db286686",
"project_status_code": "sample string 10",
"project_status": {
"id": "eeb49bec-b35d-4a70-8a03-7503967e0406",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f171863d-7a32-4800-a244-4a29691d268b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"company_id": "e599abe6-9bf0-4d84-b260-a40f080b174a",
"company_code": "sample string 12",
"db_address_id": "15e21e11-00f1-494b-8af0-c3ea10adda87",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "e606ffc6-7e14-41dc-87de-942fafa43c4e",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bf53b772-1e3c-4c33-bb8c-5b520975485b",
"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-18T21:23:17.1141622+00:00",
"date_create": "2026-09-18T21:23:17.1141622+00:00",
"date_update": "2026-09-18T21:23:17.1141622+00:00",
"updated_by_user_id": "3aed61c5-5cf7-472a-847e-992790956368",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-18T21:23:17.1141622+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-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-18T21:23:17.1141622+00:00",
"date_last_job": "2026-09-18T21:23:17.1141622+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-18T21:23:17.1141622+00:00",
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00",
"is_mobile_installation": true
},
"job_type_id": "92729230-74bb-4d59-8c05-ac926d2cc945",
"job_type_code": "sample string 7",
"job_type": {
"id": "4266d501-685b-493a-aff6-c0a8011f4a96",
"name": "sample string 2",
"sales_organization_id": "576d9297-0510-48a0-b0e7-32789ef0be84",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00",
"code": "sample string 7"
},
"job_priority_id": "9fe0df2c-8dc4-4892-8bee-0b4a102aa83a",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1492ecf8-257d-4ec0-bf79-092334044fdc",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "20d03bde-21db-46ef-ba87-4e34621987c6",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"job_status_id": "931edf00-2cfd-4f21-a81e-e3a072b2618e",
"job_status_code": "sample string 11",
"db_address_id": "f270440f-a3ed-4262-9f2d-6d1a75537116",
"contact_id": "7ea16f52-8a1d-4765-b2ff-3312f00e9e54",
"requested_by_company_id": "0d11c150-4150-4d13-a2f3-064bd2042d9d",
"requested_by_contact_id": "5590ca2f-66a0-4a6a-abde-344905690862",
"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-18T21:23:17.1141622+00:00",
"due_date": "2026-09-18T21:23:17.1141622+00:00",
"date_create": "2026-09-18T21:23:17.1141622+00:00",
"date_update": "2026-09-18T21:23:17.1141622+00:00",
"date_closed": "2026-09-18T21:23:17.1141622+00:00",
"suggested_user_id": "8e3a93c2-c6a8-4e4b-bab1-4dcff1cd902f",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "55ebd4b3-ad57-44b1-9b81-fb6cfefb9d9a",
"db_language_id": "7276b17f-d6f3-4970-a4fa-ef3df1c00d98",
"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-18T21:23:17.1141622+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ba6b3756-c23a-43bb-9a48-05660664a730",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "d6819f82-30b4-4861-b455-e72da346b8c8",
"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": "d960f7ba-5b7b-46ca-acc6-af0e674e85c6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "91c64c1b-f64d-433f-a8c7-bbdc0a973836"
},
"suggested_date_start": "2026-09-18T21:23:17.1141622+00:00",
"skill_id": "93b7532f-a5a5-44d3-a6c5-5a9f8a18a331",
"skill_code": "sample string 32",
"skill": {
"id": "b80f3cbd-6fb0-48bc-a4cf-3086d47cd04f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "fbfcb093-fb56-401b-9769-23cbe9eea7bb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "928d48f3-fd12-4f37-8e1b-2dd70bc21a9f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "7a2862d2-0cf2-4d79-a714-25be14da393a",
"db_currency_id": "271c8d97-e759-4fa8-a719-1a4d64783dbd",
"db_language_id": "5db34447-7abf-47c2-8b47-02d0c4cc07e1",
"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-18T21:23:17.1141622+00:00"
},
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "1f74f662-6c6d-4ad7-a08e-41d1f064af47",
"date_reported_by_company": "2026-09-18T21:23:17.1141622+00:00",
"id2": 36,
"company_id": "ccf984b4-5eab-496e-9605-5b68cd4d01ee",
"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": "4db6f603-994f-4cdf-b47d-cb2f4a186364",
"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-18T21:23:17.1141622+00:00"
},
"work_instruction_details_id": "8218e9d5-8a97-4b6a-aba7-36c0b5310d92",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e80ba967-6dd7-4cdc-bc54-f2e1b83996b2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "745ee62b-6119-48c5-9d2d-18741eeb15e2",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-18T21:23:17.1141622+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": "91799965-7c17-4f88-a645-6d3551e42055",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-18T21:23:17.1141622+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.