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": "98bcd10f-3779-458a-a236-c98460121454",
"jobs_id": "41e9a0dd-40c0-4642-b6fc-9e035c5d6bf2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9ed711ba-e5b1-4475-89bb-5ed4832ff778",
"_parent_id": "c200b46b-e4b0-4fe8-8435-e5cd03613bba",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fc3fd9c7-6042-46ee-9b75-786409fe29b9",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4c7e592e-725e-4032-b9bd-85a57eafd96e",
"_parent_id": "795bae64-310c-4439-a31b-48b2bb46f422",
"root_parent_id": "71ad5d89-35b7-4e86-89d9-ed8eb681588d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5217de97-0737-4e5c-bb3f-e9a97be7ee13",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "39c1864c-4bb6-4da1-b0a6-6a2efb0dfaf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8b050a1-3a85-45e9-9f7b-5382019b1754",
"_parent_code": "sample string 6",
"sales_organization_id": "963ca079-3c2b-44d2-bd03-efa2ea7923c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"modified_dateutc": "2026-08-26T11:56:44.6507582+00:00"
},
"equipment_model_id": "ae1db0ad-0bc4-48d4-9924-a2235df9d486",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4629b191-d60c-4c39-8c36-f173039a591c",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "183364e3-3c6a-4417-98a5-c13c236b73b1",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "35652539-6908-40f3-9afd-819001ad4ce0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c04fb726-8f8d-498e-8fb3-94c6be266317",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"modified_dateutc": "2026-08-26T11:56:44.6507582+00:00"
},
"equipment_family_id": "bf6d1c1d-e9b6-4546-907a-b15c834316cd",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "39c1864c-4bb6-4da1-b0a6-6a2efb0dfaf4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "b8b050a1-3a85-45e9-9f7b-5382019b1754",
"_parent_code": "sample string 6",
"sales_organization_id": "963ca079-3c2b-44d2-bd03-efa2ea7923c3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"modified_dateutc": "2026-08-26T11:56:44.6507582+00:00"
},
"date_in_production_since": "2026-08-26T11:56:44.6507582+00:00",
"date_out_of_production_since": "2026-08-26T11:56:44.6507582+00:00",
"date_end_support": "2026-08-26T11:56:44.6507582+00:00",
"sales_organization_id": "6e3c3807-da17-44e9-96e1-3c5c74efda4f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+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-08-26T11:56:44.6663837+00:00"
},
"project_status_id": "c4dbc3f9-e3d0-4271-9ca5-a8eb6cc272c4",
"project_status_code": "sample string 10",
"project_status": {
"id": "af474bee-8617-422e-8d04-1a3a0dc98fbe",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "139f81fc-0665-48be-9e7c-af5147b69275",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00"
},
"company_id": "8cecb695-3116-43da-9967-052d6b4153d1",
"company_code": "sample string 12",
"db_address_id": "26aed2b7-db24-4e17-a3b6-4a48a5854c8b",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "33bdc906-85ab-47a7-b838-c9a93f76d560",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "694f0636-c938-4ef8-afe4-7faf75911470",
"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-08-26T11:56:44.6663837+00:00",
"date_create": "2026-08-26T11:56:44.6663837+00:00",
"date_update": "2026-08-26T11:56:44.6663837+00:00",
"updated_by_user_id": "8afa94e9-576a-45dc-aaa6-2785c8fc878a",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-26T11:56:44.6663837+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-08-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-26T11:56:44.6663837+00:00",
"date_last_job": "2026-08-26T11:56:44.6663837+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-26T11:56:44.6663837+00:00",
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00",
"is_mobile_installation": true
},
"job_type_id": "ab4f84b6-bbe9-41d3-9ed6-919293167625",
"job_type_code": "sample string 7",
"job_type": {
"id": "a86e8593-f3cf-46c7-afde-daa6a534a3ba",
"name": "sample string 2",
"sales_organization_id": "9a07097d-508b-4209-9b15-50c253c80250",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00",
"code": "sample string 7"
},
"job_priority_id": "7906ec58-5a67-45a6-85c7-5443239d5d96",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "91657353-2538-4a46-8ad9-6f3529270486",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eb8019d7-073e-4458-a89a-8b227958096f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00"
},
"job_status_id": "bd21586f-de64-4aea-a82a-fbfb0814205b",
"job_status_code": "sample string 11",
"db_address_id": "349f5564-d892-4d20-a7d9-99e21221540f",
"contact_id": "acd458d8-86e5-4554-af2b-ca7d520892f2",
"requested_by_company_id": "5969dfd0-6d4a-4c32-9bf3-3bdcf3278008",
"requested_by_contact_id": "f733f8a6-7ebc-4be3-bd7f-2344631fd509",
"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-08-26T11:56:44.6663837+00:00",
"due_date": "2026-08-26T11:56:44.6663837+00:00",
"date_create": "2026-08-26T11:56:44.6663837+00:00",
"date_update": "2026-08-26T11:56:44.6663837+00:00",
"date_closed": "2026-08-26T11:56:44.6663837+00:00",
"suggested_user_id": "3ecd4f15-5e62-4a72-92cb-aad69010f12d",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "83414ee6-b558-46a3-9b18-dd84eaecdbc4",
"db_language_id": "912960c7-bc94-4e23-abf7-55f6fb28a6d2",
"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-08-26T11:56:44.6663837+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9866fd3a-6473-4cc7-b130-5d609148e13a",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "272338a9-e227-4a78-8fc3-81b8bce7f902",
"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": "2615ed9d-e03d-46b3-948f-6141c3470730",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b0bf1e29-ce4c-43f1-ad0a-891975e627f2"
},
"suggested_date_start": "2026-08-26T11:56:44.6663837+00:00",
"skill_id": "df3b1865-734a-4cf8-a42b-a6b44c6ce9de",
"skill_code": "sample string 32",
"skill": {
"id": "059bc46e-673e-4295-bb09-747c3d6aa6a9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "17fd5c72-d9ed-4136-9839-f653a5b915e9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "74ae5214-5e7e-4bde-8d01-1b79bdbc7227",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "6f6c64e7-9bd2-4ac1-89cf-a8ba3ff1641e",
"db_currency_id": "c877a071-f8ee-4428-9a80-fc8c260e9d50",
"db_language_id": "e7b68228-f682-441e-b17e-ece6dbe5f0ef",
"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-08-26T11:56:44.6507582+00:00"
},
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e0b0c222-299c-4aa8-984e-6fe1a331b0bd",
"date_reported_by_company": "2026-08-26T11:56:44.6663837+00:00",
"id2": 36,
"company_id": "b633d679-f528-4ef4-92e9-b63e2bc99860",
"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": "62d167f9-18bd-47d0-a296-15b3e030ca7b",
"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-08-26T11:56:44.6663837+00:00"
},
"work_instruction_details_id": "042c1373-419c-4029-a0ea-c4cffc2092e1",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b3d44dac-3387-45cd-bbfd-ffb097c595b6",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5a8aa49d-382a-43ee-aea9-6b5aee6f2c7e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-26T11:56:44.6663837+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": "6857ab61-db65-4986-b13c-998631976673",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-26T11:56:44.6663837+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.