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": "8cebe73f-0c21-4550-8435-1c777813b6bf",
"jobs_id": "79f3df0d-2fce-4423-97ef-3c400e587c55",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "afebfdc6-ed08-47be-83d4-a124d1c03485",
"_parent_id": "c77c24a9-e305-47f8-8950-90972f455ea5",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ddab23b0-2f2f-4989-a508-cc020fba743f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "b65693c6-ac2d-40ff-8a7a-d2e133efa9f8",
"_parent_id": "93169f94-59be-4cdd-a304-ab9f01129c86",
"root_parent_id": "b213e6be-675f-4e4e-9552-3461718e255e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "00e628fe-5f15-4fa0-8407-a85237c9a9c1",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "820576de-7f67-4f54-b1f0-45986f55d7f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "262b2d5b-7aba-489b-b4ba-616c9ebfbb00",
"_parent_code": "sample string 6",
"sales_organization_id": "6f969337-7bf5-4914-9c64-a82bee28f432",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"modified_dateutc": "2026-01-16T17:05:00.9597688+00:00"
},
"equipment_model_id": "d9aa6634-a808-4a25-997e-c1fb358fa625",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ddd0e0ca-d899-4b64-9b29-92dc23c97480",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "7f5984f6-c000-414e-93d9-11a9c8788397",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9d3b3452-270a-406c-84f9-9d764cfa9522",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "8c9420c8-8375-4dac-a842-3ef2c95fc8dc",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"modified_dateutc": "2026-01-16T17:05:00.9597688+00:00"
},
"equipment_family_id": "6a462c8c-b37a-44b2-a894-143029cfbeef",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "820576de-7f67-4f54-b1f0-45986f55d7f1",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "262b2d5b-7aba-489b-b4ba-616c9ebfbb00",
"_parent_code": "sample string 6",
"sales_organization_id": "6f969337-7bf5-4914-9c64-a82bee28f432",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"modified_dateutc": "2026-01-16T17:05:00.9597688+00:00"
},
"date_in_production_since": "2026-01-16T17:05:00.9597688+00:00",
"date_out_of_production_since": "2026-01-16T17:05:00.9753564+00:00",
"date_end_support": "2026-01-16T17:05:00.9753564+00:00",
"sales_organization_id": "5ab9739c-cc53-457b-8ad4-e83830f3b012",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+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-01-16T17:05:00.9753564+00:00"
},
"project_status_id": "ef2df697-39d4-4e0a-91d1-f5d8e42dff9c",
"project_status_code": "sample string 10",
"project_status": {
"id": "5a7fd129-46cc-4add-b029-05228b338ac6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "b8164c7a-4c4c-44b1-95de-12e8241f6ca5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00"
},
"company_id": "a51ea82a-4baf-43e1-8fcc-b6caba6409b2",
"company_code": "sample string 12",
"db_address_id": "30289691-3116-403e-8cec-c62c9548af0a",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5270ea9a-c523-49d5-9c3c-57dd701ddfd7",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5116030f-4b48-487a-96f6-524cf55c232f",
"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-01-16T17:05:00.9753564+00:00",
"date_create": "2026-01-16T17:05:00.9753564+00:00",
"date_update": "2026-01-16T17:05:00.9753564+00:00",
"updated_by_user_id": "24a26ff4-222a-4b08-85c1-54e72815c047",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-16T17:05:00.9753564+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-01-16T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-16T17:05:00.9753564+00:00",
"date_last_job": "2026-01-16T17:05:00.9753564+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-16T17:05:00.9753564+00:00",
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00",
"is_mobile_installation": true
},
"job_type_id": "9d91a687-bf67-4ccb-8659-04961db1ca93",
"job_type_code": "sample string 7",
"job_type": {
"id": "22b7f6c7-b854-45a7-a329-0780307d68af",
"name": "sample string 2",
"sales_organization_id": "3f84df23-10cb-48a4-81d9-4beb9f2b46c5",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00",
"code": "sample string 7"
},
"job_priority_id": "65d06580-dc50-464e-b9d4-c1e10f025693",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "64b89840-b650-4da4-af3f-759d16a432a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "eda96acf-1cc4-42fe-9278-9564f2263f6b",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00"
},
"job_status_id": "2454aeda-4174-48e4-80f2-016cff97c57e",
"job_status_code": "sample string 11",
"db_address_id": "45af24fb-3388-4014-a5fc-ec1a610112ce",
"contact_id": "815153f8-bd57-4eb1-813e-d89d917f97d9",
"requested_by_company_id": "84f12c9c-7f05-4cb7-9aed-d7f5c06e2786",
"requested_by_contact_id": "a2dfe7d7-aaeb-4ec8-a714-8af70b82dda6",
"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-01-16T17:05:00.9753564+00:00",
"due_date": "2026-01-16T17:05:00.9753564+00:00",
"date_create": "2026-01-16T17:05:00.9753564+00:00",
"date_update": "2026-01-16T17:05:00.9753564+00:00",
"date_closed": "2026-01-16T17:05:00.9753564+00:00",
"suggested_user_id": "4031b54f-592c-4908-b22e-464fe3e36dc6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "1c5a5bef-8bb8-4c4b-a556-9b0e9d4af7bb",
"db_language_id": "4e5a8055-9a16-400b-9d39-1acc00194d67",
"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-01-16T17:05:00.9753564+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "2abd55b3-6618-4225-a612-4718652c1ed1",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "42e00245-9606-412a-8d56-5bad70485819",
"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": "7556c068-fd3d-48d9-b9a7-704fb4b6a94a",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "18dc292c-40e9-467c-ad0e-062e7e60ee63"
},
"suggested_date_start": "2026-01-16T17:05:00.9753564+00:00",
"skill_id": "16958457-c910-4c71-b022-9ef5fa8d869f",
"skill_code": "sample string 32",
"skill": {
"id": "b316d46b-df8d-4d4d-9b9d-e8271d466297",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "bf0199c0-2315-461c-834e-825ec07aa23e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "91618b50-d135-4055-90ea-347be53cc380",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "fd448309-fdd1-447b-9299-80b91f33b221",
"db_currency_id": "b9311e92-b5f8-4a53-b3dd-1ab2bb5da29a",
"db_language_id": "d510f9f7-0f99-491b-8cb8-5c0ea2cd6f1a",
"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-01-16T17:05:00.9597688+00:00"
},
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "37d6855e-57b2-4c13-851d-48f9adb94769",
"date_reported_by_company": "2026-01-16T17:05:00.9753564+00:00",
"id2": 36,
"company_id": "b823012c-0952-48dd-aa7c-e19d5aa4ced1",
"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": "b0684188-2571-4ac3-a20c-048e8be4f8df",
"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-01-16T17:05:00.9753564+00:00"
},
"work_instruction_details_id": "1fc85c2c-4b07-41a3-9fcd-c52b896afa3b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "7e4be4d3-9487-4c1d-a6c4-ec2f0d9effdd",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4bb70469-84fa-4c1a-a603-5f5b4accb115",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-16T17:05:00.9753564+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": "bf11deb7-68c2-443b-9382-e3e1318b9cec",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-16T17:05:00.9753564+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.