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": "967e81a0-7b64-4c9a-8614-46e0a6329f48",
"jobs_id": "589b652d-254b-4505-993d-eb949ce434e2",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "db114177-516f-42c4-987c-27275d360025",
"_parent_id": "5a28768a-0219-4e6d-b094-6978a0655ce8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "475671bf-225d-4d50-bf19-340d4fe3b9fa",
"project_reference_back_office": "sample string 5",
"project": {
"id": "96956f9a-bd0c-4d46-aa0d-1a44e2eed8d8",
"_parent_id": "dbb8a384-5a6c-4689-8c6a-8168db7cd89c",
"root_parent_id": "02b4e5f5-5128-4680-81b4-012809861335",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f1e9fc24-012e-4fa8-93fc-df8e40758ed7",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "be746c5f-50fc-4fd1-a51a-6077ea17dab5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81f59a5b-c274-4a9d-ad26-81bb502cf580",
"_parent_code": "sample string 6",
"sales_organization_id": "d79e9785-6648-4dc3-a027-8bbfa417f8e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"equipment_model_id": "a4381177-320c-481e-bf75-223c7a012545",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c81bf111-57a4-40ef-868d-ae3dbbdf377d",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "fecbe09c-8894-4423-a4ad-e7c540bd96cc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "c5ab8704-3c4e-4cdd-b9ec-1f6a16710cb4",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "c7e615ba-1566-4e3e-8141-a9907c13b40d",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"equipment_family_id": "de524307-6fc6-4448-ae85-3f709f0ec6f6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "be746c5f-50fc-4fd1-a51a-6077ea17dab5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "81f59a5b-c274-4a9d-ad26-81bb502cf580",
"_parent_code": "sample string 6",
"sales_organization_id": "d79e9785-6648-4dc3-a027-8bbfa417f8e3",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"date_in_production_since": "2026-11-02T04:58:16.4890393+00:00",
"date_out_of_production_since": "2026-11-02T04:58:16.4890393+00:00",
"date_end_support": "2026-11-02T04:58:16.4890393+00:00",
"sales_organization_id": "d333d45d-7b74-4538-8f55-d81dc87bc4d7",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+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-11-02T04:58:16.4890393+00:00"
},
"project_status_id": "94434990-0aa5-4124-9ecb-e61b9d58021c",
"project_status_code": "sample string 10",
"project_status": {
"id": "10eb4f25-d1a1-49d4-8935-d163dfe2eacf",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "99cf23fd-2afe-4564-ae27-c688c0a27e45",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"company_id": "7f295ab0-770b-4bda-8417-b2e6be16d4dd",
"company_code": "sample string 12",
"db_address_id": "4caab0ee-5e14-4287-8da9-c46e87b161dc",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "085f1f1d-5290-48b5-b024-478d9ab53368",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "bade57b0-5cee-4d5d-9858-08870f7e4a1f",
"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-11-02T04:58:16.4890393+00:00",
"date_create": "2026-11-02T04:58:16.4890393+00:00",
"date_update": "2026-11-02T04:58:16.4890393+00:00",
"updated_by_user_id": "22532770-1bea-40a3-9ecd-c4cef5ae6218",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-11-02T04:58:16.4890393+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-11-02T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-11-02T04:58:16.4890393+00:00",
"date_last_job": "2026-11-02T04:58:16.4890393+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-11-02T04:58:16.4890393+00:00",
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00",
"is_mobile_installation": true
},
"job_type_id": "08cdecef-c70a-4a44-81e9-6a9679ee7de2",
"job_type_code": "sample string 7",
"job_type": {
"id": "2a9af2a3-0015-4267-b5db-5954a3c05a04",
"name": "sample string 2",
"sales_organization_id": "e9dca1dd-7b68-4e1f-953c-9c051b5fe30c",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00",
"code": "sample string 7"
},
"job_priority_id": "d09be52f-24c0-4610-b89f-474d16c3b581",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a180770a-1d83-49b0-8e0a-ce3cb282332f",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4564c50e-3c57-417f-b023-0d35755e52ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"job_status_id": "1253c44b-54f7-48fb-8619-841c0cda85b5",
"job_status_code": "sample string 11",
"db_address_id": "b1c1d95c-7d2b-4650-853f-dafcd04bb771",
"contact_id": "1951c1c4-c46c-45f2-81de-25ddf8612778",
"requested_by_company_id": "f5888db4-9831-497a-b5d4-58e998f2271a",
"requested_by_contact_id": "2d756d5e-7d6c-4afc-a892-e0155a812971",
"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-11-02T04:58:16.4890393+00:00",
"due_date": "2026-11-02T04:58:16.4890393+00:00",
"date_create": "2026-11-02T04:58:16.4890393+00:00",
"date_update": "2026-11-02T04:58:16.4890393+00:00",
"date_closed": "2026-11-02T04:58:16.4890393+00:00",
"suggested_user_id": "ccbdd857-7e25-4b34-b104-70e819a575cd",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "2c9dad1f-59a2-4204-af5c-c8dae07c5b2c",
"db_language_id": "fdc1682c-8318-4ec8-bac7-418d03078f60",
"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-11-02T04:58:16.4890393+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f1733b7c-9de5-4aef-b32c-4898466d35d1",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "21930cfe-14e0-45ff-9a49-420a2e15b7c9",
"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": "aa464a88-30a0-46dc-956c-69a26f019695",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f30484f6-4559-43da-aabe-2b454ca862b5"
},
"suggested_date_start": "2026-11-02T04:58:16.4890393+00:00",
"skill_id": "abea5607-4880-484c-82fc-861c61d4a04a",
"skill_code": "sample string 32",
"skill": {
"id": "080ff950-cd40-49a6-8cef-d5488d990ac5",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "6de8f67b-8fc5-415f-a33c-b703780287ed",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "86014720-6a41-4f92-a94a-31fc09d77db6",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "9dc7af4d-536d-458d-b851-a3164aed1c99",
"db_currency_id": "6f92f026-fdd5-43bd-81ce-d63b7d14faa1",
"db_language_id": "712b6419-ca17-4edf-bc59-0ccfbe6e0352",
"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-11-02T04:58:16.4890393+00:00"
},
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "513bb037-cb4a-4754-a4e9-1d2e91d95f8a",
"date_reported_by_company": "2026-11-02T04:58:16.4890393+00:00",
"id2": 36,
"company_id": "b6d5d371-8856-463f-803d-08feeabc4e05",
"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": "aecd3b32-6a03-43fc-9ed0-299548b0d750",
"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-11-02T04:58:16.4890393+00:00"
},
"work_instruction_details_id": "99b6d300-afa4-4edd-8ef4-a15987bffa31",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "86f28b3c-5691-468a-a0ea-a55dbfff6414",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2238d4d2-c102-4d21-a1d3-e42658108181",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-11-02T04:58:16.4890393+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": "51955055-fd7e-4f60-9c6d-3d0b01a00d5f",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-11-02T04:58:16.4890393+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.