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": "7f9d5221-5674-4324-ab1b-1f7d3cdec7dc",
"jobs_id": "ac572856-43c2-4eea-ae96-6996e45030c5",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "383e0d39-47df-4dea-b3e9-c17e6d6c4b18",
"_parent_id": "0ab9b042-9791-475c-ba3f-fe569ae45331",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "767c006c-ec50-4430-bde6-ac1b1a9c688b",
"project_reference_back_office": "sample string 5",
"project": {
"id": "4df3a9c6-0da6-4e59-9126-128d48228bd5",
"_parent_id": "b720c0eb-30af-4999-870e-5ec6990a3471",
"root_parent_id": "88781ded-4b15-4b7b-8562-decaa1e18390",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "7456aa48-d7fc-4b2d-9d2b-9a904fec6021",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "eb7549ea-efdd-47ef-af50-5659b73daf29",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83f58d3d-9bc8-4609-a792-bdd8b1a03ad9",
"_parent_code": "sample string 6",
"sales_organization_id": "57173af9-440f-49b7-a805-e6aa4be9ecfe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00"
},
"equipment_model_id": "5a69f270-1475-4ceb-a3a0-1058aed55950",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "4e575bce-c376-4f97-ac8e-7f5924d6b52a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "aa8c3841-1cd2-4eda-b0f5-af48c6935d38",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "7b278c92-720c-4a4e-a282-7a45741c181d",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "bc2e9979-bfcd-4cc0-b9f0-34d00eadb923",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00"
},
"equipment_family_id": "08b33d08-838e-47e6-a28b-ca6832723ecb",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "eb7549ea-efdd-47ef-af50-5659b73daf29",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "83f58d3d-9bc8-4609-a792-bdd8b1a03ad9",
"_parent_code": "sample string 6",
"sales_organization_id": "57173af9-440f-49b7-a805-e6aa4be9ecfe",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00"
},
"date_in_production_since": "2026-02-08T06:49:52.9897991+00:00",
"date_out_of_production_since": "2026-02-08T06:49:52.9897991+00:00",
"date_end_support": "2026-02-08T06:49:52.9897991+00:00",
"sales_organization_id": "b2d4ef7d-c4af-4c01-adae-9e334c63cfca",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+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-02-08T06:49:52.9897991+00:00"
},
"project_status_id": "055b3780-d9eb-4378-8cf8-330fc93bc925",
"project_status_code": "sample string 10",
"project_status": {
"id": "3eb20ac1-f91c-402c-893f-f502269e3a6c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "66a6c67b-e106-4e18-9fb1-034057f18cbd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00"
},
"company_id": "aad23dad-b67a-4b66-b3fb-e62bfb1f978a",
"company_code": "sample string 12",
"db_address_id": "e413618b-8247-4c8f-ad2f-3b618f2d92d1",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "14b5f620-c9b5-42d3-9fd5-9b2a6a766476",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b3041c37-7313-436b-bbd4-ca4fa1a13593",
"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-02-08T06:49:52.9897991+00:00",
"date_create": "2026-02-08T06:49:52.9897991+00:00",
"date_update": "2026-02-08T06:49:52.9897991+00:00",
"updated_by_user_id": "cda292f6-1153-4eb2-b099-4bfa35c554e4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-02-08T06:49:52.9897991+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-02-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-02-08T06:49:52.9897991+00:00",
"date_last_job": "2026-02-08T06:49:52.9897991+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-02-08T06:49:52.9897991+00:00",
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00",
"is_mobile_installation": true
},
"job_type_id": "5b15eee9-91ed-4993-8d08-9e4fb4333f9f",
"job_type_code": "sample string 7",
"job_type": {
"id": "706046c0-4594-4e5a-8da9-90fc84721515",
"name": "sample string 2",
"sales_organization_id": "391ac4b4-bd8b-41a0-bd7c-e117e05c4e25",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00",
"code": "sample string 7"
},
"job_priority_id": "3e178558-b9b2-4ea0-b051-ee3f18c8afb7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "4aedbbe0-3b03-490b-8c6d-4d63678c9142",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4746194a-1b98-4bf2-a12c-7f31f903a94e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-02-08T06:49:52.9897991+00:00"
},
"job_status_id": "900bab38-f794-483f-bc01-84de0aca6f50",
"job_status_code": "sample string 11",
"db_address_id": "b41ec4e8-1eca-4881-aee0-594071ea8fc2",
"contact_id": "c0cb3aba-6976-4e6b-a40d-3d082d349d14",
"requested_by_company_id": "407bb074-771a-4ebd-b437-c1420b17608d",
"requested_by_contact_id": "cfa07977-f867-428d-9d59-a8dc112cdd5f",
"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-02-08T06:49:52.9897991+00:00",
"due_date": "2026-02-08T06:49:52.9897991+00:00",
"date_create": "2026-02-08T06:49:52.9897991+00:00",
"date_update": "2026-02-08T06:49:52.9897991+00:00",
"date_closed": "2026-02-08T06:49:52.9897991+00:00",
"suggested_user_id": "3d6e16ba-3f06-4e3b-99a9-1a5e98ae4f52",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1781aaab-c92d-44ae-a962-4e824e088a85",
"db_language_id": "32478937-46d4-436d-ac05-b11ffee67eac",
"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-02-08T06:49:52.9897991+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "0e042719-8b45-4280-aec1-3b3b8e796130",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "7affd3c3-0d9d-4771-bd27-25d5ab6c380d",
"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": "3ed48b92-b237-48f5-9da9-f90dbabc186d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-02-08T06:49:53.0054257+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "719b0184-e5ee-44d7-8617-1bd5433bba2a"
},
"suggested_date_start": "2026-02-08T06:49:53.0054257+00:00",
"skill_id": "7766013a-021b-45d1-ba0e-36df09a91035",
"skill_code": "sample string 32",
"skill": {
"id": "0e036530-c8ae-4fe3-b63d-2bc04a59270b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8d91baa9-edea-4ba2-8606-a7479f40144d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "699db1ca-01e6-47a6-8791-ff8a34e89bbb",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "56c7e3e0-f09a-483d-9378-86def772c005",
"db_currency_id": "9b55fb57-c89c-4698-b3b7-142f332a7a13",
"db_language_id": "f809ae12-4331-48d8-a2c7-3b58137eadf7",
"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-02-08T06:49:52.9897991+00:00"
},
"modified_dateutc": "2026-02-08T06:49:53.0054257+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e24fee2e-f139-4fc3-898f-b9dcc89b6e17",
"date_reported_by_company": "2026-02-08T06:49:53.0054257+00:00",
"id2": 36,
"company_id": "c9dd3e7b-b8ba-40a1-97de-5b7683534270",
"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": "56f70012-bf0c-49fa-bd30-58b8d0ad1334",
"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-02-08T06:49:53.0054257+00:00"
},
"work_instruction_details_id": "180141a1-60e2-42ef-8d9d-aded59889e4e",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "87b2550d-e05a-48cf-a50a-726f73adcbdc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "2daf6f72-71c3-4e39-99c2-33de9b706c17",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-02-08T06:49:53.0054257+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": "96ac1edf-7848-4e26-a4d9-5cfa34bec24e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-02-08T06:49:53.0054257+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.