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": "60b6e707-229f-4c48-8d64-67a45e94ec36",
"jobs_id": "45b6b406-d475-44c5-b745-788f5b81db0b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "b1502d98-5014-462b-90bc-b5fdae629c1c",
"_parent_id": "6b65cd2a-59e4-47e0-8cba-f1fb9f589049",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "d09f7f34-8534-4955-9807-09cc17efb51b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b8a4ada8-ffcd-4390-9d60-25cfc12b82c5",
"_parent_id": "c0d16155-f6a1-444b-a566-6e470f2a5d66",
"root_parent_id": "dc8ca877-1d27-4db2-a074-a32c63729371",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8f7727fd-64c5-43b4-a14a-7d350dfd8a42",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4147cdb0-89cd-4210-ac86-5f8814acf4dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6fed5c4-4431-4f66-bf96-9adab5cfb9fe",
"_parent_code": "sample string 6",
"sales_organization_id": "20c499c3-612c-4351-8f39-1c2604144db6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"equipment_model_id": "26318f30-937d-46eb-b45a-fd690e0706c6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c8a48cd8-ca81-4199-bf1a-a33695ddae84",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "d64e62a2-bf1d-41dc-96cc-11fef311af9a",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7073084c-e061-49e9-9dd2-3c0a6591b3ff",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3b9e8ef6-ff19-473b-9375-d2ab878f8e13",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"equipment_family_id": "7a742773-988f-480c-8a7f-821a3dfc4eff",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4147cdb0-89cd-4210-ac86-5f8814acf4dd",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f6fed5c4-4431-4f66-bf96-9adab5cfb9fe",
"_parent_code": "sample string 6",
"sales_organization_id": "20c499c3-612c-4351-8f39-1c2604144db6",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"date_in_production_since": "2026-10-17T17:17:01.8789793+00:00",
"date_out_of_production_since": "2026-10-17T17:17:01.8789793+00:00",
"date_end_support": "2026-10-17T17:17:01.8789793+00:00",
"sales_organization_id": "c57f4a26-2747-4ebd-9feb-0c513e95725c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+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-10-17T17:17:01.8789793+00:00"
},
"project_status_id": "02955cf7-2d8c-4ea9-88fa-d9cf0c5322f6",
"project_status_code": "sample string 10",
"project_status": {
"id": "2a58fef1-4524-48fa-8645-513175e28c36",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "17ee52cf-15a4-42c8-889e-8dd4ae053b8c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"company_id": "0cb47766-7681-4dde-a3f9-62925c6852a3",
"company_code": "sample string 12",
"db_address_id": "3e0da00f-a833-443d-88b6-97fe6a556c39",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "18bc1108-229e-4f54-9fd7-653bc62c7ef3",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "edf288d7-9c85-4cc8-991f-47930f9a7b7b",
"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-10-17T17:17:01.8789793+00:00",
"date_create": "2026-10-17T17:17:01.8789793+00:00",
"date_update": "2026-10-17T17:17:01.8789793+00:00",
"updated_by_user_id": "541940bc-3d6d-4a30-94d6-72bf4f20a9c8",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-10-17T17:17:01.8789793+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-10-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-10-17T17:17:01.8789793+00:00",
"date_last_job": "2026-10-17T17:17:01.8789793+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-10-17T17:17:01.8789793+00:00",
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00",
"is_mobile_installation": true
},
"job_type_id": "b927b82c-1aed-4a87-9279-eb2fd07e4e23",
"job_type_code": "sample string 7",
"job_type": {
"id": "bcb367a1-5d6b-4844-b340-ae3a66458e0e",
"name": "sample string 2",
"sales_organization_id": "3cc0d03e-c9e3-49df-8724-01cc6463348b",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00",
"code": "sample string 7"
},
"job_priority_id": "02ec17e0-748d-4159-b20e-00110e160b44",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "cbf9d02b-dd5c-4f82-bfd7-d08ee052ad85",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "328c2e7d-ae14-4ba6-9bd8-87bdae902100",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"job_status_id": "c73f04d3-a477-4b14-86d7-c6ddcabda224",
"job_status_code": "sample string 11",
"db_address_id": "a3e950a5-cae9-4fcd-a5b0-5cace7b722c1",
"contact_id": "f05d8af2-655e-4829-a765-336f983c9228",
"requested_by_company_id": "8bcd016b-7b44-4498-babe-2b19634a2651",
"requested_by_contact_id": "0da38452-04d3-4fe9-b26f-6d085d9cb0d5",
"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-10-17T17:17:01.8789793+00:00",
"due_date": "2026-10-17T17:17:01.8789793+00:00",
"date_create": "2026-10-17T17:17:01.8789793+00:00",
"date_update": "2026-10-17T17:17:01.8789793+00:00",
"date_closed": "2026-10-17T17:17:01.8789793+00:00",
"suggested_user_id": "cd102998-48b9-4fe7-94f2-5f3c934a395b",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "5d3296ea-c431-4c9e-bfdc-f93a4f2f377f",
"db_language_id": "300cdc02-a525-498b-a39c-36c2fe1686f0",
"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-10-17T17:17:01.8789793+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "f191d98a-e899-480d-9431-a71d48b73d6f",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "63a79883-165c-40a0-894a-515b4b4dc745",
"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": "ff741f0a-abe7-41e4-abda-4362ef8f0615",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "4e783f5e-90ba-4b97-bce8-9928c78da71d"
},
"suggested_date_start": "2026-10-17T17:17:01.8789793+00:00",
"skill_id": "fcffbbb8-bbbd-445a-ba89-9684b661bf14",
"skill_code": "sample string 32",
"skill": {
"id": "e1b7cced-b97e-43cb-96a3-fc73e965fda1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "ee525546-2175-4bcf-9342-a250c93ea999",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "dd74fedd-8784-4b44-b2cc-f946ee6a637f",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "1bca2731-60ef-4e9c-a43a-ce3fd7194abe",
"db_currency_id": "a80d2d72-607d-4b14-9305-0f567c785125",
"db_language_id": "be2e3145-6315-424a-a308-21ea6c452117",
"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-10-17T17:17:01.8789793+00:00"
},
"modified_dateutc": "2026-10-17T17:17:01.8789793+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "4b417a2e-58ac-456b-8f7c-e8fc58e9252c",
"date_reported_by_company": "2026-10-17T17:17:01.8789793+00:00",
"id2": 36,
"company_id": "e860c8d9-4979-461a-b372-58b7079e5f4b",
"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": "18dabe8c-74e5-4001-b3de-c0f34aaeece3",
"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-10-17T17:17:01.8789793+00:00"
},
"work_instruction_details_id": "517f9468-70b0-416a-b908-3720bfa15914",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "3b1462e9-787e-438c-a10f-d2ff122184f2",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "bb594255-5881-46b8-badf-2927ed7ecf16",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-10-17T17:17:01.8789793+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": "6c8c8243-dc5f-47d7-9994-f6dcd31098ca",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-10-17T17:17:01.8985225+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.