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": "0f405f14-bc26-45f3-ba57-c3bd1c3bf9ba",
"jobs_id": "e8b97765-7756-46ad-bcf2-3a9c19662002",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "85c98d6c-fe71-4e44-81c9-d03e5685ab37",
"_parent_id": "95e34f23-2f47-4473-a547-16aa514fb9ac",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "73284151-6265-43cd-ad26-05cf6d513c4f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "5f868108-d92a-4418-a779-3d9f8f14ab2e",
"_parent_id": "c707d0a5-624c-4b65-b775-369478a33c93",
"root_parent_id": "6e561334-cca9-445c-829a-aa21a74d8fe2",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "21b895e2-1026-4391-bea1-cfb45635b6a6",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "424d16f7-39e5-4d40-b2ad-799413879a77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5fccdba-2f7b-4480-8712-d06be8ae77be",
"_parent_code": "sample string 6",
"sales_organization_id": "31bc15ec-2767-4a3d-85d9-ac9fc9a4e5d5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"equipment_model_id": "28dcbe2e-0763-4c7e-98d3-349ac19c8ce9",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "493c2ef7-6255-44bf-a980-01e892061e54",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "40732f9a-2d17-4ef7-a584-091885a43db5",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a57f2a3f-f00e-47d2-9d62-015bbad60860",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "88923d6f-06fd-47a0-9852-fcfef054f949",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"equipment_family_id": "63d9e62a-23a1-4df1-af09-acb43858aa88",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "424d16f7-39e5-4d40-b2ad-799413879a77",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "e5fccdba-2f7b-4480-8712-d06be8ae77be",
"_parent_code": "sample string 6",
"sales_organization_id": "31bc15ec-2767-4a3d-85d9-ac9fc9a4e5d5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"date_in_production_since": "2026-05-07T13:55:34.3143083+00:00",
"date_out_of_production_since": "2026-05-07T13:55:34.3143083+00:00",
"date_end_support": "2026-05-07T13:55:34.3143083+00:00",
"sales_organization_id": "acebd070-0f2c-4862-883e-cf3236645780",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+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-05-07T13:55:34.3143083+00:00"
},
"project_status_id": "d38069b1-1d2b-454d-b65b-a745d6092882",
"project_status_code": "sample string 10",
"project_status": {
"id": "53827e2f-550e-42e6-8eb9-7d7c015f2620",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "c51c84c6-d12e-4d91-bb2a-c09e344ae180",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"company_id": "d9d11d98-1c0e-49ef-a29b-02491068bff6",
"company_code": "sample string 12",
"db_address_id": "e0a493a5-5966-4c6b-b242-7b4e537fa42d",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "c60e0c77-e1ca-43a8-8d63-811cf107e122",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "3dc04e1e-043f-4776-932a-140b6ba893ac",
"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-05-07T13:55:34.3143083+00:00",
"date_create": "2026-05-07T13:55:34.3143083+00:00",
"date_update": "2026-05-07T13:55:34.3143083+00:00",
"updated_by_user_id": "18089c88-7cc3-41fe-b81f-f7d1c1471b83",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-07T13:55:34.3143083+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-05-07T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-07T13:55:34.3143083+00:00",
"date_last_job": "2026-05-07T13:55:34.3143083+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-07T13:55:34.3143083+00:00",
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00",
"is_mobile_installation": true
},
"job_type_id": "c033d0d6-b0ae-42b9-b574-3bffc88a2684",
"job_type_code": "sample string 7",
"job_type": {
"id": "7aadddc5-beb0-4edd-bfc3-ea946f4a4800",
"name": "sample string 2",
"sales_organization_id": "3817d1b0-f28a-435e-8a16-a4b76b8ba5d3",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00",
"code": "sample string 7"
},
"job_priority_id": "26d16dfe-1311-4a84-bb43-4c0e44e35eb5",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "22c05cea-46e0-479a-9e0e-c596357652a8",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4a152b4d-9896-4d12-8300-6145c4039cc4",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"job_status_id": "0636bf5e-f548-4f97-8db9-70254cfa6ef8",
"job_status_code": "sample string 11",
"db_address_id": "46cd473f-3b87-4d0b-8c70-ad95ed3979bf",
"contact_id": "a6049521-fa8b-40c4-beb7-ab6f1b0b6ac3",
"requested_by_company_id": "01c3b1c6-cc28-424d-8b94-3f25b367ed6b",
"requested_by_contact_id": "06aa83e7-555e-4ed1-b22f-65ef6fcd97b8",
"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-05-07T13:55:34.3143083+00:00",
"due_date": "2026-05-07T13:55:34.3143083+00:00",
"date_create": "2026-05-07T13:55:34.3143083+00:00",
"date_update": "2026-05-07T13:55:34.3143083+00:00",
"date_closed": "2026-05-07T13:55:34.3143083+00:00",
"suggested_user_id": "c2cbc133-1ac0-446a-a860-9a37c11a8a49",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "b2019c92-075e-476b-ac40-402bf0d9eb9e",
"db_language_id": "43c1215a-aa1c-4987-9110-5b4902fb9fe2",
"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-05-07T13:55:34.3143083+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d023ccb5-b73d-4a0e-89ed-3016c830bd5d",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "bc3a38c1-f3cb-4751-84b0-d64f98f671f9",
"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": "9edddbbd-e280-4690-af33-06a3433a0219",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b42a4e3b-e544-483d-a145-9d86c6e0f8c9"
},
"suggested_date_start": "2026-05-07T13:55:34.3143083+00:00",
"skill_id": "587cadae-2107-4193-be02-ea01fc922454",
"skill_code": "sample string 32",
"skill": {
"id": "766cfc1f-5d23-46bb-a233-2e340aff435e",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "df6246a5-569f-4b00-a548-5ee8bc0e69ac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "f5d3e31e-5dcb-4dd5-9a76-7c42035d3199",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "707f365a-34c6-4d85-8b5a-230289afbd73",
"db_currency_id": "d1be293a-44fb-47fa-96a5-33d7e24414b1",
"db_language_id": "bd97e596-1d27-42c4-a2df-daf71f872f6c",
"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-05-07T13:55:34.3143083+00:00"
},
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "ec87c1bb-fdab-4b9e-a42a-391b83b4ecf0",
"date_reported_by_company": "2026-05-07T13:55:34.3143083+00:00",
"id2": 36,
"company_id": "d3b56450-a4c4-41e0-b8e3-c2b4382ca3f2",
"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": "2064c27d-045d-4bc3-ab0b-7035acfc651a",
"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-05-07T13:55:34.3143083+00:00"
},
"work_instruction_details_id": "85e05311-ccaf-4fd7-8c5a-48020812b7be",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "daa92cdb-fc98-4a70-a261-84adcc35ed81",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "785fe867-27ee-46e9-8cbf-08ec91e07f7d",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-07T13:55:34.3143083+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": "bcd55b5c-3052-4688-9e23-277d02f76411",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-07T13:55:34.3143083+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.