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": "3bc239cd-e1e9-4dbc-a4be-996605c75411",
"jobs_id": "6d071776-4d53-4dcb-b02f-9fd752c5c58e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "982d9cbf-a3c5-444e-a6ab-b6ed7cc520bb",
"_parent_id": "69264948-bf8c-4aac-987c-ea6631814ce1",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d3f447c6-68a7-487f-a9e8-89198ffd2971",
"project_reference_back_office": "sample string 5",
"project": {
"id": "1201af9d-1722-4a3c-b1e1-ff97cdaefde3",
"_parent_id": "cc67f1a1-305e-488f-a2de-fa9624ce0c6a",
"root_parent_id": "022b7afd-d52a-407a-92cc-e3bff54b6914",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "10f021ea-cf85-4dcb-94dd-3735b0b395d4",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "288491e1-258d-4b43-99ee-7f21c2bac279",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0c210b28-cc8e-4017-a7b9-9ef8ef33a094",
"_parent_code": "sample string 6",
"sales_organization_id": "dec8cd51-beeb-4438-9e8b-ffaab4f33a2f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"modified_dateutc": "2026-02-09T07:04:37.6629016+00:00"
},
"equipment_model_id": "34c10414-3b24-42cc-9810-50a0c356bcc7",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "80ffc878-2713-4e38-be83-2804472d32e6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6e16eb45-1952-446e-b0dc-55d0b4a96108",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "96543475-503e-4914-a86a-6163fc88433c",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "152f5f9b-2d44-4ad0-8611-07507527696f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"modified_dateutc": "2026-02-09T07:04:37.6629016+00:00"
},
"equipment_family_id": "5a7dd729-f1b3-42e1-9f24-a02b7694960f",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "288491e1-258d-4b43-99ee-7f21c2bac279",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "0c210b28-cc8e-4017-a7b9-9ef8ef33a094",
"_parent_code": "sample string 6",
"sales_organization_id": "dec8cd51-beeb-4438-9e8b-ffaab4f33a2f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"modified_dateutc": "2026-02-09T07:04:37.6629016+00:00"
},
"date_in_production_since": "2026-02-09T07:04:37.6629016+00:00",
"date_out_of_production_since": "2026-02-09T07:04:37.6629016+00:00",
"date_end_support": "2026-02-09T07:04:37.6629016+00:00",
"sales_organization_id": "c06d2e74-a588-4fd2-a022-02958e6c7e42",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+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-02-09T07:04:37.6629016+00:00"
},
"project_status_id": "cf13b6d5-3d78-400c-9367-a9516d8ada88",
"project_status_code": "sample string 10",
"project_status": {
"id": "cb11175d-1db5-4469-baab-9b48733b2ed6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bab5af5f-1bc9-41dd-af42-bd9e45b6476b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T07:04:37.6629016+00:00"
},
"company_id": "9dce3e82-4982-43a7-8ccb-dbd051d3a7ab",
"company_code": "sample string 12",
"db_address_id": "c305db0a-bcaa-414a-a163-ef40ae871c9a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "6b726b3a-fa41-4157-bb35-7154f17aef63",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "7e4f0de6-ab35-42b3-a419-c743942ab4ce",
"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-02-09T07:04:37.6629016+00:00",
"date_create": "2026-02-09T07:04:37.6629016+00:00",
"date_update": "2026-02-09T07:04:37.6629016+00:00",
"updated_by_user_id": "b1e71783-e04d-4dd4-a1ec-d85a33b128b1",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-09T07:04:37.678524+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-02-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-09T07:04:37.678524+00:00",
"date_last_job": "2026-02-09T07:04:37.678524+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-09T07:04:37.678524+00:00",
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00",
"is_mobile_installation": true
},
"job_type_id": "2807c4d2-a328-4c13-aefc-58013d972cdc",
"job_type_code": "sample string 7",
"job_type": {
"id": "b944a140-665a-49f3-98b5-99bb5dd7a5c3",
"name": "sample string 2",
"sales_organization_id": "3044b8f9-36f0-47ce-9cf0-132c4968d660",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00",
"code": "sample string 7"
},
"job_priority_id": "404f7a1e-0aab-47f5-bbb5-19c1ce8da3b9",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "07a20d7b-0725-46b3-ab51-44d5dea648a6",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "ffea1907-5e2a-4340-ab00-eff968c262a2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00"
},
"job_status_id": "662c67dc-1e47-4ee4-b753-9f9cce9894eb",
"job_status_code": "sample string 11",
"db_address_id": "9ae71067-f89a-4b07-806a-037532093831",
"contact_id": "180b42f3-c840-4075-b973-c55cb97eed42",
"requested_by_company_id": "8a1acd30-67e7-46d6-85a0-226ff7af7657",
"requested_by_contact_id": "29a31c51-c6c1-4087-90ba-e237717952d6",
"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-02-09T07:04:37.678524+00:00",
"due_date": "2026-02-09T07:04:37.678524+00:00",
"date_create": "2026-02-09T07:04:37.678524+00:00",
"date_update": "2026-02-09T07:04:37.678524+00:00",
"date_closed": "2026-02-09T07:04:37.678524+00:00",
"suggested_user_id": "8e1f9963-85dd-4259-8391-acf6079364aa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ac9c4b0d-78db-469d-bc3c-6af8a80e4ad4",
"db_language_id": "974301d3-86b7-467a-a714-18adf730fdca",
"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-02-09T07:04:37.678524+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "37d79af8-78e1-4d1d-8877-fbd5b27df386",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "03b7deed-38c7-4c54-9d85-6fa06abfd472",
"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": "80012e7c-77f7-4de0-beb1-2dec386e8d9b",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "8b41cc19-97fa-4a23-b2d4-b7d8d8d73847"
},
"suggested_date_start": "2026-02-09T07:04:37.678524+00:00",
"skill_id": "48022e7f-58e2-4952-8576-bd9dbacabd0e",
"skill_code": "sample string 32",
"skill": {
"id": "682e9642-d4bf-4695-909a-439ce64aac0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b4efcab8-1e9d-4d66-a196-dd0051c19c16",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "03104ebc-66ba-4891-b33c-41622717f6bf",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "638b2c8b-b312-49e5-9de6-c07dd97d4988",
"db_currency_id": "d8d0834d-0564-4c7d-b24f-f867b05dbd4c",
"db_language_id": "d694fd0f-5164-4d09-bde7-61da8985192d",
"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-02-09T07:04:37.6629016+00:00"
},
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9341dd34-84f3-4614-b999-ab23c3af1e85",
"date_reported_by_company": "2026-02-09T07:04:37.678524+00:00",
"id2": 36,
"company_id": "fad4dd1c-ed90-49be-a633-63c6bd771a88",
"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": "0e259e3e-8730-4d03-9ece-476269579ce9",
"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-02-09T07:04:37.678524+00:00"
},
"work_instruction_details_id": "6dd59be6-4abc-4a2e-adb4-3c15f4295d9b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "0c6cf805-605f-459c-9e82-a7f1304c8565",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "1bebc990-0e45-4fd1-a89c-49ce9b8c6c94",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-09T07:04:37.678524+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": "a447f5d1-bae1-475d-aa1b-7599fe79f55c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-09T07:04:37.678524+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.