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": "7d0e510a-48f8-4a67-b4f3-4c65770bea15",
"jobs_id": "5398d54d-82a1-4f88-8010-9e06f5c66ad2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "cfecdfde-0e13-43b1-b4c6-1afdbe75829d",
"_parent_id": "2d59bc66-1624-4ba3-a1cd-334c8c4679b2",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d63ae4e6-26f6-45c0-a95b-a8aeb289952f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "81098387-02a2-4b85-8a21-f2bd72449533",
"_parent_id": "94807e0f-ec65-4ee1-8edb-efe16c6379d1",
"root_parent_id": "162db44a-e045-4d31-8390-e7371c401548",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "097d3f7a-c2a4-4e20-a888-4940d7e34827",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c8f9f569-3fc5-4a21-8e25-eae4f6bc3cc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df1d48c2-053f-433d-818e-5308d19f5d6b",
"_parent_code": "sample string 6",
"sales_organization_id": "91a20d5a-2d41-4a7b-88e7-e916a1bd6f31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"modified_dateutc": "2026-07-02T20:39:41.2144501+00:00"
},
"equipment_model_id": "f2fae455-60dc-4552-ab54-012f3d860018",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "053a8358-a533-4176-9961-7ebe89c23a2b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "650538dd-d5b0-4a28-8761-8a431b4ea92d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6b45d663-58d3-470e-b154-59a11b0713a4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "696dea29-97dc-4647-a64a-7680de34e58d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"modified_dateutc": "2026-07-02T20:39:41.2144501+00:00"
},
"equipment_family_id": "903ed77c-1e96-4997-930e-4f24e012e7dc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c8f9f569-3fc5-4a21-8e25-eae4f6bc3cc9",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "df1d48c2-053f-433d-818e-5308d19f5d6b",
"_parent_code": "sample string 6",
"sales_organization_id": "91a20d5a-2d41-4a7b-88e7-e916a1bd6f31",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"modified_dateutc": "2026-07-02T20:39:41.2144501+00:00"
},
"date_in_production_since": "2026-07-02T20:39:41.2144501+00:00",
"date_out_of_production_since": "2026-07-02T20:39:41.2144501+00:00",
"date_end_support": "2026-07-02T20:39:41.2144501+00:00",
"sales_organization_id": "2ba2c238-eaeb-46d8-b706-fb4d59a02bcd",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+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-07-02T20:39:41.2300676+00:00"
},
"project_status_id": "bd138c84-4588-4287-9fa9-c04711383f48",
"project_status_code": "sample string 10",
"project_status": {
"id": "a016b1ba-e133-47f7-b99f-d8170f04a0c6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e47a95dc-1b6b-4214-969d-743cf5846db7",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00"
},
"company_id": "58d67a71-d218-4f0b-89e0-b4b3cecb7dbb",
"company_code": "sample string 12",
"db_address_id": "81a19111-23d9-4e2f-8e94-5bc27073d252",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "4d068e16-8c5e-48c0-b462-c1723a75e06f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "d053046c-fd4a-4ed7-89ee-52f5d8d8dc88",
"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-07-02T20:39:41.2300676+00:00",
"date_create": "2026-07-02T20:39:41.2300676+00:00",
"date_update": "2026-07-02T20:39:41.2300676+00:00",
"updated_by_user_id": "f332b761-2d06-4c80-98eb-8da83c39805e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-02T20:39:41.2300676+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-07-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-02T20:39:41.2300676+00:00",
"date_last_job": "2026-07-02T20:39:41.2300676+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-02T20:39:41.2300676+00:00",
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00",
"is_mobile_installation": true
},
"job_type_id": "d7f58ddd-e062-4275-8315-30bb332d2437",
"job_type_code": "sample string 7",
"job_type": {
"id": "988e48c0-3974-41b5-ad11-b41d553f9518",
"name": "sample string 2",
"sales_organization_id": "e0d5d9df-ef71-4387-854e-fdbbeb6dd36d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00",
"code": "sample string 7"
},
"job_priority_id": "48dc314f-ffb8-4148-a4f8-f0c735c3b453",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "1c671943-a12c-439c-8ade-203708cd5440",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "90b4bd4f-6443-4179-86bf-36640494de94",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00"
},
"job_status_id": "b50039ec-a29c-4b4a-859a-8a2578fc799e",
"job_status_code": "sample string 11",
"db_address_id": "8ed6597d-4940-4b71-b8a3-7a0ab6b355f5",
"contact_id": "824f6ed8-fe58-4309-b7f9-b2fb7446d76d",
"requested_by_company_id": "937c0d05-50f4-44e6-ac99-2e46b8990c7a",
"requested_by_contact_id": "5d8e4ea6-66bb-4002-8b73-9d802da037f8",
"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-07-02T20:39:41.2300676+00:00",
"due_date": "2026-07-02T20:39:41.2300676+00:00",
"date_create": "2026-07-02T20:39:41.2300676+00:00",
"date_update": "2026-07-02T20:39:41.2300676+00:00",
"date_closed": "2026-07-02T20:39:41.2300676+00:00",
"suggested_user_id": "1ca8c14f-7ea1-422a-9a0d-d48b1f805cbb",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bed3b46a-cd20-4b1f-89fe-f1ada1457cab",
"db_language_id": "e0bfbaa9-62a2-441e-93cf-132eb9a652f3",
"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-07-02T20:39:41.2300676+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0a120a9f-feaa-44b0-a750-bcb018a2ae63",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "0531fdc2-0971-42c7-969c-5941479de555",
"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": "ed04e28d-5c91-48e9-a88e-9f97642080b8",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ed99eea7-6ea4-49cd-9881-3e6ae8fba573"
},
"suggested_date_start": "2026-07-02T20:39:41.2300676+00:00",
"skill_id": "242f51b5-3eda-4f91-b7b6-7f7c23e7f6ad",
"skill_code": "sample string 32",
"skill": {
"id": "405f6f00-80cc-4b37-a0bd-794275161d25",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "a165e6fa-41bf-4d4a-9fe7-9ad0ef51968d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "64da0c3a-0cf3-4d38-a22c-3ff7f7fb78d6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "c411e8cc-2cfb-4539-9881-ddfdad63e3f1",
"db_currency_id": "701df111-4961-4446-9cc8-0c5096de70b8",
"db_language_id": "80e8882f-1a96-44a1-b7a6-0c8f5cf9a602",
"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-07-02T20:39:41.2144501+00:00"
},
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "10cfccb8-2f1a-453f-b44d-07bcc984a8cf",
"date_reported_by_company": "2026-07-02T20:39:41.2300676+00:00",
"id2": 36,
"company_id": "1fe14b62-37f8-4c5d-8cc2-30a12d45ef4a",
"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": "0d634c89-8221-4e3f-9cef-62155dc18b01",
"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-07-02T20:39:41.2300676+00:00"
},
"work_instruction_details_id": "e5ddb380-e5bb-46b9-bf1b-e152910fff95",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "27130039-ac6f-4dff-8802-d9ab955ce18e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "dd15f935-9f66-4424-8c1a-fed45d87bcda",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-02T20:39:41.2300676+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": "4e11f14c-acf4-4943-b576-7ffbbd531321",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-02T20:39:41.2300676+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.