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": "4a6f2b4f-1559-42ff-9fd6-f5baac6a1511",
"jobs_id": "d9c716bf-62d5-43d0-a3e4-b6a9cff733ec",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "74042822-4206-4df1-9379-2546cd090660",
"_parent_id": "cd9384c9-300e-4c90-836b-cd60413a6d18",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "3f6f593e-478d-4bc5-83a0-c0d7974cb0a6",
"project_reference_back_office": "sample string 5",
"project": {
"id": "3b5e7e18-46be-408a-a1c8-7cbfbc2f63a0",
"_parent_id": "e6b7bc77-aec1-4133-a4d6-5fb1c850b9e4",
"root_parent_id": "fe7806b0-af3f-4acd-9f2d-9436f4cdf0c1",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "5a879ad5-06bb-44bf-aa96-5c7d72930e0b",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "853d07e8-ea23-4a0b-a8d0-e82449496c61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "75e8cfc9-d9c4-4190-a257-26812c7baec8",
"_parent_code": "sample string 6",
"sales_organization_id": "838b63f9-af41-417e-bec8-76a7345a56b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"equipment_model_id": "056bab03-ec41-4829-b880-463fedcf9814",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "67ff09f2-23cc-495c-b2f2-ba26ef1291fa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f9a04d69-f4ee-48b4-8fe4-528ecf777310",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "dce28a34-d5b3-4203-8def-8015f846624e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fbee7f79-73e7-462a-b2b9-b23cfab81e9a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"equipment_family_id": "977a7e4c-f329-4a57-8d6f-badbe762151a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "853d07e8-ea23-4a0b-a8d0-e82449496c61",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "75e8cfc9-d9c4-4190-a257-26812c7baec8",
"_parent_code": "sample string 6",
"sales_organization_id": "838b63f9-af41-417e-bec8-76a7345a56b1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"date_in_production_since": "2025-06-21T11:04:11.726868+00:00",
"date_out_of_production_since": "2025-06-21T11:04:11.726868+00:00",
"date_end_support": "2025-06-21T11:04:11.726868+00:00",
"sales_organization_id": "dab99e49-a8e1-4268-b689-fa05aa55fd4b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+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": "2025-06-21T11:04:11.726868+00:00"
},
"project_status_id": "0ed5d050-7149-48b8-880d-cef6f84c68ef",
"project_status_code": "sample string 10",
"project_status": {
"id": "009e382a-287b-4e87-8231-b2d7505b2f32",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "315cfc25-177e-418e-8c3e-4da1e84a4b12",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"company_id": "6b0acb37-6c5e-4828-ab11-27de650a7419",
"company_code": "sample string 12",
"db_address_id": "ee6026c9-e560-4410-9301-6e37da55d69d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "63fdcc87-2fc8-4db6-b9f5-d135bb585b88",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b464e08a-c8ee-4580-848e-b3e815c74855",
"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": "2025-06-21T11:04:11.726868+00:00",
"date_create": "2025-06-21T11:04:11.726868+00:00",
"date_update": "2025-06-21T11:04:11.726868+00:00",
"updated_by_user_id": "30df4953-ecb0-440b-81c6-277f43738d28",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-06-21T11:04:11.726868+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": "2025-06-21T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-06-21T11:04:11.726868+00:00",
"date_last_job": "2025-06-21T11:04:11.726868+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-06-21T11:04:11.726868+00:00",
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00",
"is_mobile_installation": true
},
"job_type_id": "64f6eddd-d834-443e-87f2-6aa230cb15bc",
"job_type_code": "sample string 7",
"job_type": {
"id": "f11d119b-7d51-4fe9-80b3-0336f789176e",
"name": "sample string 2",
"sales_organization_id": "2ab1940e-d04d-437e-9174-b7f5ccfe1ef6",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00",
"code": "sample string 7"
},
"job_priority_id": "8575a261-9725-47f2-898c-bb87a36e4e74",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "95e1811d-ce51-4f8d-b89c-c7b301691732",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "fd1467f5-ce5a-40ef-a2f8-7861f0e26123",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"job_status_id": "62dee4fe-d6c8-4b3c-9526-418783a1c658",
"job_status_code": "sample string 11",
"db_address_id": "ff67eef0-4800-41b3-960a-18957cd10c7c",
"contact_id": "bbfbe910-adc0-43dd-a7ab-870d575e639a",
"requested_by_company_id": "cba74387-05c5-4367-98a6-1e31475b6e44",
"requested_by_contact_id": "9d96f456-ce21-4127-9ff6-90247aad5f89",
"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": "2025-06-21T11:04:11.726868+00:00",
"due_date": "2025-06-21T11:04:11.726868+00:00",
"date_create": "2025-06-21T11:04:11.726868+00:00",
"date_update": "2025-06-21T11:04:11.726868+00:00",
"date_closed": "2025-06-21T11:04:11.726868+00:00",
"suggested_user_id": "f42f29f3-f152-4268-adf8-0f6e78c50c93",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "bc10e76b-663c-4737-9d11-026699c6deff",
"db_language_id": "06cdcf43-30e5-4ab2-bd5f-49a198596f22",
"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": "2025-06-21T11:04:11.726868+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cf02ebcb-96f2-4ad4-9f2c-9461e9c20c91",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "cfa13f6c-59f3-46c4-ba6e-0991ead03c17",
"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": "8b6846f6-2ea5-470d-a071-920f58512ccc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d0b7b022-133c-42f5-8eb9-961893423078"
},
"suggested_date_start": "2025-06-21T11:04:11.726868+00:00",
"skill_id": "bf4ca204-f3d4-48cf-b295-1e1f5112b619",
"skill_code": "sample string 32",
"skill": {
"id": "c4bc3f96-c407-47eb-a509-c399d950b1bf",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "1b5776b4-ea5a-42be-8522-86ae1d789486",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "e537a570-6d59-492b-b5de-7d911cc107cc",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "57012b6e-c58a-4272-a8ed-26a572f4351e",
"db_currency_id": "ee002f6b-ca7e-4ad3-a4b2-9007085bb551",
"db_language_id": "5e59624c-f311-4416-9028-317507c394cb",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"modified_dateutc": "2025-06-21T11:04:11.726868+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7042adcc-1b1d-4005-b1f6-98c1816fbf5d",
"date_reported_by_company": "2025-06-21T11:04:11.726868+00:00",
"id2": 36,
"company_id": "6cbea6f8-fffa-4e27-b44e-dbe93f688947",
"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": "407e6b00-16da-4d70-a956-32a57af98626",
"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": "2025-06-21T11:04:11.726868+00:00"
},
"work_instruction_details_id": "fb412c58-1029-40a9-9239-5847d0301b14",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b9c0d64a-80eb-4073-99a8-558c280a525f",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "3b65fa38-308a-41a8-a642-030a79d628ea",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-06-21T11:04:11.726868+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": "21dc8e6d-5678-457b-bf20-5bbe8649d7da",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-06-21T11:04:11.7425039+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.