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": "dafb1593-bbf8-4a93-ba91-5d730cf87e6d",
"jobs_id": "cfa4e14f-f21b-49ff-8f75-78d719d72c0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "99653371-3781-4e33-8dfa-df96f7590661",
"_parent_id": "30b4be17-9974-4d5c-9d06-d2901ba40bff",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d8a0966d-f679-42bc-a8af-c87dbe00497a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0b586759-0177-4202-b811-ccc5c448f9f9",
"_parent_id": "502e856f-2415-44c9-b140-1600e3d7e3e5",
"root_parent_id": "266593e6-7faa-4fef-94e9-4d28cf86d683",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "a67bb5de-48b5-4449-9d84-7d26d564c639",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "073cf2bb-02d6-4b59-91a9-3667355eaab8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "078e087a-c1a0-4e5a-8152-1f2952800b59",
"_parent_code": "sample string 6",
"sales_organization_id": "df1a920a-bce7-402a-824c-4645c961c480",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00"
},
"equipment_model_id": "3af99154-2be9-461a-92c7-1de0118657cc",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "27eea0bd-e5f4-4138-9ee8-61def39b8bc0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "ef854a27-d45a-4e7f-b8f8-3d9bff5b6f17",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "2b5ee0ff-1e12-405a-a4fd-aa7a8eb553e3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fa63c38f-3626-4662-9d35-2b5c76cbd009",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00"
},
"equipment_family_id": "3ad8abce-6361-4161-a0a9-abea0d288227",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "073cf2bb-02d6-4b59-91a9-3667355eaab8",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "078e087a-c1a0-4e5a-8152-1f2952800b59",
"_parent_code": "sample string 6",
"sales_organization_id": "df1a920a-bce7-402a-824c-4645c961c480",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00"
},
"date_in_production_since": "2026-04-04T19:38:32.2991661+00:00",
"date_out_of_production_since": "2026-04-04T19:38:32.2991661+00:00",
"date_end_support": "2026-04-04T19:38:32.2991661+00:00",
"sales_organization_id": "1b4e7263-c909-455d-b597-48d64eccd039",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+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-04-04T19:38:32.2991661+00:00"
},
"project_status_id": "80041987-aeef-4682-b399-4be0fdebba4f",
"project_status_code": "sample string 10",
"project_status": {
"id": "34a9b557-d2e9-4210-864c-31629b12700c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5750ee13-9a97-4d81-8ca6-f67b2fb32b07",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00"
},
"company_id": "8e745d1e-14bb-4337-8896-9c3fbc6207c1",
"company_code": "sample string 12",
"db_address_id": "4e4e216e-e36a-4d73-bb12-4986b265a359",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ae04a660-2717-4502-a018-ff33943324c5",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "40f29138-0b55-49fb-9562-ab13a24d2af3",
"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-04-04T19:38:32.2991661+00:00",
"date_create": "2026-04-04T19:38:32.2991661+00:00",
"date_update": "2026-04-04T19:38:32.2991661+00:00",
"updated_by_user_id": "d1242752-b970-477e-9a47-b39bc56883ad",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-04T19:38:32.2991661+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-04-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-04T19:38:32.2991661+00:00",
"date_last_job": "2026-04-04T19:38:32.2991661+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-04T19:38:32.2991661+00:00",
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00",
"is_mobile_installation": true
},
"job_type_id": "62293b83-815f-4a51-92b0-4d811c44c723",
"job_type_code": "sample string 7",
"job_type": {
"id": "91705cd3-7351-40c7-8395-814d20276cbb",
"name": "sample string 2",
"sales_organization_id": "3e00cd9f-8c26-46a5-bdce-4876bcf48304",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00",
"code": "sample string 7"
},
"job_priority_id": "dfa9f6af-3693-4837-bb58-19003b2327e6",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "610031aa-984e-4d20-bf40-035664127c18",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "f1d185b2-9041-4960-ad41-586d4afe6272",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-04T19:38:32.2991661+00:00"
},
"job_status_id": "722cc2f4-01a1-4066-882c-15693aa177e6",
"job_status_code": "sample string 11",
"db_address_id": "d177221f-8a65-4895-947d-af5454c2a733",
"contact_id": "1a506c27-9106-434a-a427-12dda5f9c08b",
"requested_by_company_id": "80c58277-49a0-47a3-9831-86c9033e7089",
"requested_by_contact_id": "cbeb7259-6de2-4c41-af3f-0acb218d5451",
"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-04-04T19:38:32.2991661+00:00",
"due_date": "2026-04-04T19:38:32.2991661+00:00",
"date_create": "2026-04-04T19:38:32.2991661+00:00",
"date_update": "2026-04-04T19:38:32.2991661+00:00",
"date_closed": "2026-04-04T19:38:32.2991661+00:00",
"suggested_user_id": "7a7274ad-6925-4eae-996e-43983958074c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5398feb3-6040-4ec0-97e5-817e484b9380",
"db_language_id": "0e7ff9d9-209e-4378-aff6-8c0016aa9f89",
"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-04-04T19:38:32.2991661+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "693f4a33-2870-4a45-8018-1ff1d933ea5d",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c6af1e5d-f2bc-4388-8a71-b39aa5ba77e9",
"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": "22e42ac8-68de-41cd-af19-a9e8763a2a93",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-04T19:38:32.3147899+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "2f1d73b9-b294-4e83-ab5c-023c48fd5336"
},
"suggested_date_start": "2026-04-04T19:38:32.3147899+00:00",
"skill_id": "e496b7f6-b438-479a-9895-c475c133ae1c",
"skill_code": "sample string 32",
"skill": {
"id": "16aba752-a024-475b-b692-726c97be7b17",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1ae517fc-9f1a-4dfa-8875-cbf561e2585d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "eecda8ef-482f-4a6e-9c25-cee720725b26",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "03ee1ffb-ada6-44cd-a393-9c070e8be89a",
"db_currency_id": "8cabf847-0996-4115-a389-97e70448f7cf",
"db_language_id": "f3ab0dc9-b384-4a29-a4fa-4ba84891ee00",
"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-04-04T19:38:32.2991661+00:00"
},
"modified_dateutc": "2026-04-04T19:38:32.3147899+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4ac3013b-6ce5-4969-8851-a203d9790988",
"date_reported_by_company": "2026-04-04T19:38:32.3147899+00:00",
"id2": 36,
"company_id": "b21f928d-cf1c-4e96-9bd1-5d0da35dd48f",
"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": "63d19bee-55f4-459d-8c3d-bfe7e8d88cbb",
"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-04-04T19:38:32.3147899+00:00"
},
"work_instruction_details_id": "4aa4abf0-d85e-4f91-9210-0c503c21957e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e99964f2-53cb-4aff-aa20-aa39a45f938f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "84fe6c27-cf03-4356-a82a-6b33d91d1525",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-04T19:38:32.3147899+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": "6669e92b-6dcc-42c9-b817-e69e4553afde",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-04T19:38:32.3147899+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.