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": "53670bd4-505b-4b28-b143-e7e48f0ffe06",
"jobs_id": "4d713bd1-92a3-472d-8bd0-933e0f590b31",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "11bd011b-e522-44e1-a740-5899b6ac3ca9",
"_parent_id": "40891c89-d1d6-4e58-8298-9037e1176500",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "699b7739-ac83-4b0b-af0c-c00429cc7844",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9fa7aef1-87d2-4773-9d74-9482f685ad08",
"_parent_id": "75ebe2ee-340b-4375-913e-40340acc372f",
"root_parent_id": "78f55785-cb7a-4148-8ec9-573d3b1ff40f",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "39ab7313-7eee-4516-a559-ddfc5c861769",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "50a18234-163c-4a76-b9f6-c37e7e881f82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e19585f-19e6-4080-9c58-dad5b9858730",
"_parent_code": "sample string 6",
"sales_organization_id": "74da2ddb-4a36-4b52-9fed-1d3df039817b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"modified_dateutc": "2026-07-15T00:40:27.7264584+00:00"
},
"equipment_model_id": "d9574c02-b2e5-439e-80f7-7fa471ccab83",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "696624dd-de26-4b4c-9077-756f61f23570",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "396c3503-6903-4ae1-9ec7-d7fc95b1f369",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "1a3dd4d4-099a-4b54-a23a-cbf76bc1257b",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "cb573ce4-727c-4e6f-9e86-9b690b41c47f",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"modified_dateutc": "2026-07-15T00:40:27.7264584+00:00"
},
"equipment_family_id": "3e362440-7631-4b7d-b704-2e54af38e3c0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "50a18234-163c-4a76-b9f6-c37e7e881f82",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5e19585f-19e6-4080-9c58-dad5b9858730",
"_parent_code": "sample string 6",
"sales_organization_id": "74da2ddb-4a36-4b52-9fed-1d3df039817b",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"modified_dateutc": "2026-07-15T00:40:27.7264584+00:00"
},
"date_in_production_since": "2026-07-15T00:40:27.7264584+00:00",
"date_out_of_production_since": "2026-07-15T00:40:27.7264584+00:00",
"date_end_support": "2026-07-15T00:40:27.7264584+00:00",
"sales_organization_id": "e224e139-0493-4fc4-b472-62cb61115e27",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+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-15T00:40:27.9295792+00:00"
},
"project_status_id": "d2588d09-5afe-487d-bd1c-6554d1df273f",
"project_status_code": "sample string 10",
"project_status": {
"id": "a06b3ace-31a4-43d0-a13b-804504eac3e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "399c6ec5-dede-48e5-9501-cbd8820da9ee",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00"
},
"company_id": "82305469-1523-4d9a-b5e9-4ebd20108996",
"company_code": "sample string 12",
"db_address_id": "6dd102c6-2f28-4a18-8c54-9d46721264af",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "14e2fc13-d4e5-457c-a675-4d2d643620f9",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "ef879388-8fe5-468a-814e-742b5b4a6ddd",
"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-15T00:40:27.9295792+00:00",
"date_create": "2026-07-15T00:40:27.9295792+00:00",
"date_update": "2026-07-15T00:40:27.9295792+00:00",
"updated_by_user_id": "40712e50-6c6c-4e41-8807-7c5eac7a5470",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-15T00:40:27.9295792+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-15T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-15T00:40:27.9295792+00:00",
"date_last_job": "2026-07-15T00:40:27.9295792+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-15T00:40:27.9295792+00:00",
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00",
"is_mobile_installation": true
},
"job_type_id": "5f1986b3-3c28-4ddb-bd0f-2891d6f597f2",
"job_type_code": "sample string 7",
"job_type": {
"id": "2262b03e-37f5-4575-8d55-669a541549e8",
"name": "sample string 2",
"sales_organization_id": "71b7b088-b755-4789-89fe-b8ee96cde445",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00",
"code": "sample string 7"
},
"job_priority_id": "75c3fde8-74f9-4c1f-82b1-2dce166a58be",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "85ea1a08-ed0f-4aab-bdd7-99fde35559d3",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a7e01c77-63bf-43a6-9468-1341cae7d619",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00"
},
"job_status_id": "1de2a337-e48f-4139-afca-57d908f754cc",
"job_status_code": "sample string 11",
"db_address_id": "ed82d1ad-86db-4f02-8e49-ab96cb1f9539",
"contact_id": "7cf8045a-5960-4e83-838e-14ae16495015",
"requested_by_company_id": "6bcf71d0-d9db-4ce1-bb2e-a9e8db1cd31a",
"requested_by_contact_id": "f45ac774-8c66-445a-b5ee-bb2afc3e9e5a",
"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-15T00:40:27.9295792+00:00",
"due_date": "2026-07-15T00:40:27.9295792+00:00",
"date_create": "2026-07-15T00:40:27.9295792+00:00",
"date_update": "2026-07-15T00:40:27.9295792+00:00",
"date_closed": "2026-07-15T00:40:27.9295792+00:00",
"suggested_user_id": "8f7c37ba-5c01-4c56-b926-5ef53adb8b38",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ac764baf-02d4-4e61-819e-36e521c7f00b",
"db_language_id": "6b1c92f7-6946-4f18-bb84-1536bd1e7f67",
"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-15T00:40:27.9295792+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d8004fc5-55f3-46d2-a893-0ba43f756b82",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e7eaaeda-f126-4ff6-9738-58db143f8454",
"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": "603a1869-9571-472b-ba33-292a188d8655",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "39f36bcc-8649-4bd4-8875-c786a544f0de"
},
"suggested_date_start": "2026-07-15T00:40:27.9295792+00:00",
"skill_id": "3555f86b-ac81-4d4e-ad3b-fd4ff1ac38e5",
"skill_code": "sample string 32",
"skill": {
"id": "44f486d0-1aca-407a-9083-e0a9b3e6a71b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "d7f9da7b-7bb2-4e96-ad0f-494a683f333a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "1d7f13a5-b420-4fcc-a52d-252a67cba66a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "73e26713-d9db-4760-a01d-e33f6960f949",
"db_currency_id": "a57e3c7f-e7b2-4d6f-91d4-a6ad002e23d3",
"db_language_id": "ad2a57fa-a808-411c-8bbc-51ef171765e7",
"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-15T00:40:27.7264584+00:00"
},
"modified_dateutc": "2026-07-15T00:40:27.9295792+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "002bc341-e70a-459b-8e5d-11f80621103e",
"date_reported_by_company": "2026-07-15T00:40:27.9295792+00:00",
"id2": 36,
"company_id": "6ca6c314-5637-41f2-be1b-fb4942c1c709",
"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": "5b417b4f-b769-44db-a934-d4129d1cd0cd",
"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-15T00:40:27.9295792+00:00"
},
"work_instruction_details_id": "034a4681-a061-4731-a138-fc0033d7e67c",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "e50568df-e1e2-4c37-a46d-af81d10e2b22",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "83275e72-0776-4b77-878f-0c8af15397af",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-15T00:40:27.9295792+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": "bcc1a53b-33ea-4126-81d2-721bb58804c8",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-15T00:40:27.9452036+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.