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": "b0f63af9-07e5-448d-a9a0-8cbd9aab07dc",
"jobs_id": "3fcd52ac-80ab-408b-a7b3-adac8c54f64f",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5e36aaa0-dc38-4312-9e5c-3dba90d332fd",
"_parent_id": "f9c5aec5-2f66-4879-8599-eb921b817846",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "5feac39d-bdc9-4a25-9f5a-3541f528de1a",
"project_reference_back_office": "sample string 5",
"project": {
"id": "c5b6bb31-547a-4649-bd1f-ec28bf6629ec",
"_parent_id": "7b737903-c295-4c10-8023-b9bc7d8d5611",
"root_parent_id": "95fe3164-7a6a-41d7-b197-1400492069c4",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ca568521-9c91-493d-8be2-89833023a94d",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b8b7306f-4cdb-4024-8b27-bb0e93aafcf6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24503694-fe0f-45be-89e8-52532e3dc2a0",
"_parent_code": "sample string 6",
"sales_organization_id": "29b87b8e-383f-4b9a-a94f-cfd467a6f107",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"modified_dateutc": "2025-08-12T12:29:52.3949648+00:00"
},
"equipment_model_id": "e6e68253-ef5c-4071-b993-564c9e1ce40f",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "57f0b04a-a163-4aef-9fb9-ca28dd706a0a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "732a7805-91f5-4d46-9dc8-ea7e702a2843",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "11cc9833-f3ad-4122-ad2a-e55d5c937cf3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "60a3b2d1-8f02-4490-ab74-8dc9e9690644",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"modified_dateutc": "2025-08-12T12:29:52.3949648+00:00"
},
"equipment_family_id": "8254c194-c387-4cd8-9feb-3c91f6a4691c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b8b7306f-4cdb-4024-8b27-bb0e93aafcf6",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "24503694-fe0f-45be-89e8-52532e3dc2a0",
"_parent_code": "sample string 6",
"sales_organization_id": "29b87b8e-383f-4b9a-a94f-cfd467a6f107",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"modified_dateutc": "2025-08-12T12:29:52.3949648+00:00"
},
"date_in_production_since": "2025-08-12T12:29:52.3949648+00:00",
"date_out_of_production_since": "2025-08-12T12:29:52.3949648+00:00",
"date_end_support": "2025-08-12T12:29:52.3949648+00:00",
"sales_organization_id": "84fcc56a-acb5-4011-8dbc-e5f6e917b38b",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+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-08-12T12:29:52.410578+00:00"
},
"project_status_id": "cbf0fc17-e07f-4955-aa8c-54813d7613fb",
"project_status_code": "sample string 10",
"project_status": {
"id": "45dc0e8d-4a66-4d6a-b1ea-f8e009b20144",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "073d8d73-c288-4124-b847-566b89dff73c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00"
},
"company_id": "b9f69ab9-4d53-4867-924c-13fede5e923b",
"company_code": "sample string 12",
"db_address_id": "b2b2f739-4794-407f-821b-e97342b3c7b7",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0d4050d8-caa8-4c02-b3a4-eeec8f5636df",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ab7b4d57-1c9f-45e1-afca-b96f837ecba0",
"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-08-12T12:29:52.410578+00:00",
"date_create": "2025-08-12T12:29:52.410578+00:00",
"date_update": "2025-08-12T12:29:52.410578+00:00",
"updated_by_user_id": "c48338d4-3e9b-40c5-ab42-86cd54e51f36",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-08-12T12:29:52.410578+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-08-12T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-08-12T12:29:52.410578+00:00",
"date_last_job": "2025-08-12T12:29:52.410578+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-08-12T12:29:52.410578+00:00",
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00",
"is_mobile_installation": true
},
"job_type_id": "97293dab-b0a8-46ca-a474-515e1a7df325",
"job_type_code": "sample string 7",
"job_type": {
"id": "12298a02-cd4e-447d-bcce-77160fcbe514",
"name": "sample string 2",
"sales_organization_id": "5d95f073-27b4-42f3-a03a-3316484e7ad3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00",
"code": "sample string 7"
},
"job_priority_id": "9d7eee6a-fab1-47bf-88be-467595c74920",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "eacde02e-bc40-4d5b-97cd-46d63fb6c2f5",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "0186f9f1-d14b-4ae4-b5ee-ea017e48d7b9",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00"
},
"job_status_id": "1470c1b4-0964-4b9a-9f6d-df3ed6abf69c",
"job_status_code": "sample string 11",
"db_address_id": "784d6d87-cc6c-430e-a6a0-4a817ac4ba38",
"contact_id": "6d4b96ef-14d5-45f9-96d6-f3d502027e60",
"requested_by_company_id": "db463a50-b1fd-4d1f-acf1-e72765cc2570",
"requested_by_contact_id": "951917c5-8256-477a-9084-3225c18b2a2f",
"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-08-12T12:29:52.410578+00:00",
"due_date": "2025-08-12T12:29:52.410578+00:00",
"date_create": "2025-08-12T12:29:52.410578+00:00",
"date_update": "2025-08-12T12:29:52.410578+00:00",
"date_closed": "2025-08-12T12:29:52.410578+00:00",
"suggested_user_id": "fd99c248-4dde-41c1-8ed0-074780ffeb25",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "954ff4ef-9e76-422e-b03a-9f16be27758e",
"db_language_id": "166f13a1-a798-48e9-a844-816930634a89",
"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-08-12T12:29:52.410578+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4586d8b8-b8d5-4f28-9b62-047b2e915d19",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "6f629d69-c8d9-41fc-a625-9ff10ef90992",
"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": "38e6d403-405a-4de5-be74-5e3559869cd6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aa4ebae7-b64d-43c3-a2ad-7c7a5fac5972"
},
"suggested_date_start": "2025-08-12T12:29:52.410578+00:00",
"skill_id": "211f1fe8-80f4-4db1-86d7-d859e3c4fbec",
"skill_code": "sample string 32",
"skill": {
"id": "9a4eb347-d881-4c60-86c2-3c3ea33548cb",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "67e993ed-f1cb-4185-8d0b-92e3843ef500",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "c8ddf8ae-7667-4620-9d5f-bdeee1048a30",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e6b08e66-f315-485b-9ac0-602382d27766",
"db_currency_id": "95470d5e-abb3-4fa7-ac41-26d91568261d",
"db_language_id": "79c4b151-f8f6-4131-8df3-c0fac80e922e",
"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-08-12T12:29:52.3949648+00:00"
},
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "803ac4e4-9b96-4ed9-afdf-f8ad9894c8c7",
"date_reported_by_company": "2025-08-12T12:29:52.410578+00:00",
"id2": 36,
"company_id": "95063534-5516-434b-9ae6-4b867db8bf2a",
"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": "95ca0010-f4d4-4487-8f9b-14055b9c34da",
"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-08-12T12:29:52.410578+00:00"
},
"work_instruction_details_id": "4508a9bf-9b51-433e-bb84-bf3b28d11ec8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "8f916fc7-98ab-475a-97e8-24b06de2e1a2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "950d1ff5-6408-4e56-b766-b1bcd7e73172",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-08-12T12:29:52.410578+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": "7b4deaf3-6c0a-449e-897f-23dcb6511e89",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-08-12T12:29:52.410578+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.