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": "a5198b84-b2c0-47b4-afe5-ca0f28f02792",
"jobs_id": "00738a34-4cf9-4e31-b70f-b21624f17cbd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "8a16715d-29ea-4895-9070-ec89eb21eceb",
"_parent_id": "9d87142a-7144-4240-a61d-13da0c563848",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "fd02ad95-d152-4071-9057-71b7196a1e73",
"project_reference_back_office": "sample string 5",
"project": {
"id": "86a61ac4-67e9-40fc-8656-a5730d2382fd",
"_parent_id": "03406ca3-0430-4a6a-8424-0152c4c70bc3",
"root_parent_id": "8d04936b-7aa1-49d8-8b13-77c6b1b74758",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b6d6ce3f-d639-4490-a2f9-385ae1d1e23a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2fe91f48-3b26-4f27-afae-c960857d7736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "758abd6e-b859-4c05-9762-94846f434d57",
"_parent_code": "sample string 6",
"sales_organization_id": "df67d81b-000a-46fe-8619-061c26c36600",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"equipment_model_id": "4f55901f-90cf-46fb-82d9-005cd05156f6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "34b10390-e551-4761-85d0-f85c1e219b3b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "e4b9c226-f9b8-4975-b570-6507e99ed9b0",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "4c4087f5-d82f-4b08-8cd1-0cb9d9533646",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "74c944c7-4997-4d0c-8e5e-c94eb7c682cb",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"equipment_family_id": "802b3af3-c01c-4721-8b97-84b79ce3d51c",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2fe91f48-3b26-4f27-afae-c960857d7736",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "758abd6e-b859-4c05-9762-94846f434d57",
"_parent_code": "sample string 6",
"sales_organization_id": "df67d81b-000a-46fe-8619-061c26c36600",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"date_in_production_since": "2026-09-22T22:01:08.2242568+00:00",
"date_out_of_production_since": "2026-09-22T22:01:08.2242568+00:00",
"date_end_support": "2026-09-22T22:01:08.2242568+00:00",
"sales_organization_id": "03105a69-1932-4de9-8923-5edf36e21694",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+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-09-22T22:01:08.2242568+00:00"
},
"project_status_id": "735531d3-b568-4878-a05e-100aa3a5921a",
"project_status_code": "sample string 10",
"project_status": {
"id": "0630c050-9cf4-4a6d-8d21-0e76a3f88711",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "bace6b7f-dfeb-4717-b330-f97e1d18ac15",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"company_id": "72b0cfe9-3943-4dc4-ac92-4fd7bb6470c8",
"company_code": "sample string 12",
"db_address_id": "9a0e483a-6a61-4c46-a804-9a3a18ee8648",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "0fa3d001-f320-4632-81f3-c0d057df57dd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f9e73e63-f03a-416c-8711-e27e3fcd485a",
"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-09-22T22:01:08.2242568+00:00",
"date_create": "2026-09-22T22:01:08.2242568+00:00",
"date_update": "2026-09-22T22:01:08.2242568+00:00",
"updated_by_user_id": "4d8d8ef0-dde6-4210-8fe1-e2c97121019e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-22T22:01:08.2242568+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-09-22T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-22T22:01:08.2242568+00:00",
"date_last_job": "2026-09-22T22:01:08.2242568+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-22T22:01:08.2242568+00:00",
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00",
"is_mobile_installation": true
},
"job_type_id": "6c03ebe5-bbf6-43b3-8aa6-ce8aa50efcf5",
"job_type_code": "sample string 7",
"job_type": {
"id": "297b0aea-a137-406a-9844-f919c285b3df",
"name": "sample string 2",
"sales_organization_id": "181354d1-2171-4a4f-8ca9-ecc10645ec71",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00",
"code": "sample string 7"
},
"job_priority_id": "1331aa7c-dc3b-4c92-92a0-0a5f3ff9887b",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "91209dd7-fa4c-4237-9920-d82de5537959",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "6f69c3ce-b5d0-4a73-a9ad-88567d438a5e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"job_status_id": "fd14a901-f0d1-4344-bab3-e28e0817c7c6",
"job_status_code": "sample string 11",
"db_address_id": "72eddd9c-8000-4bf6-88a5-c7cc73bc3943",
"contact_id": "b8c1369b-1b01-4762-bbdd-eea0fe2754e3",
"requested_by_company_id": "4f8f4122-e2ce-4bd4-b15c-bdf38f3605ea",
"requested_by_contact_id": "29bb6c27-0e04-49bf-83d0-42699e51f17f",
"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-09-22T22:01:08.2242568+00:00",
"due_date": "2026-09-22T22:01:08.2242568+00:00",
"date_create": "2026-09-22T22:01:08.2242568+00:00",
"date_update": "2026-09-22T22:01:08.2242568+00:00",
"date_closed": "2026-09-22T22:01:08.2242568+00:00",
"suggested_user_id": "4355caaa-e1d6-4e63-9869-60ee1ebc5ed0",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "fb9175f7-e7c4-4b59-8f27-4281214d1749",
"db_language_id": "69e6d81b-78b7-4b12-bf09-05967748ec93",
"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-09-22T22:01:08.2242568+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "4d967265-3b04-4ec8-a3b0-60affc8fdade",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2bb01eed-771c-4351-abc1-d77a29b60618",
"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": "2e3bdf1a-4689-4758-9764-b08c7a9cdead",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4b93e49e-08a2-4f96-87f6-8afcf874fafd"
},
"suggested_date_start": "2026-09-22T22:01:08.2242568+00:00",
"skill_id": "4b7d9392-88bd-4020-a085-f1bf666b63d8",
"skill_code": "sample string 32",
"skill": {
"id": "ef83b012-3f4b-40b1-8ae8-4b12b9079b06",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "33bff39c-1d44-4cc0-9588-43967b238388",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1c476ed5-13fd-47a3-8b57-4906e891f9f0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5da03684-b5c0-4512-a2c2-6252919681df",
"db_currency_id": "b4f0be79-f883-439f-aa72-089485aed157",
"db_language_id": "b6bf7644-401c-4b4c-b909-ff1a2f610690",
"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-09-22T22:01:08.2242568+00:00"
},
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "7aae8cb6-741c-4ff0-a369-c2fb554b9da0",
"date_reported_by_company": "2026-09-22T22:01:08.2242568+00:00",
"id2": 36,
"company_id": "7b17af58-224c-4690-8a3e-5526f66c0b76",
"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": "e819c136-3f5d-4d2b-83be-c71e71a24cf2",
"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-09-22T22:01:08.2242568+00:00"
},
"work_instruction_details_id": "500a01c5-4c87-49d1-87d6-2ed4fa6f190d",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "37bf02b3-144f-4c73-855f-227706d2688d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "b323924b-aefc-403f-805d-daed94a7d209",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-22T22:01:08.2242568+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": "945323e7-33a6-4877-bfc8-6edf52bc0e4e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-22T22:01:08.2242568+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.