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": "eefff029-a606-405b-a5b5-01a4d27f7c3f",
"jobs_id": "079c023c-6122-4140-ad9a-46c68dfc44d4",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "4b963891-d463-4799-a3da-84a46562fb9a",
"_parent_id": "e4b803f9-aae7-460f-a705-29bab94bdf50",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "2a9ab83e-ab50-467d-9048-ac152eaf5636",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8d8ef483-e71b-46a4-a444-052ef2594a22",
"_parent_id": "0d190136-114e-499d-9050-8ae93590bad2",
"root_parent_id": "11dadfc4-8667-40a2-b8db-96617c4d561a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "614fae3d-af22-472d-b69b-46eb2a6596f9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7f8d5d25-f9d6-4b83-be7a-5223e493def3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9bb8b96b-80ee-4764-9530-73fc21f7d566",
"_parent_code": "sample string 6",
"sales_organization_id": "8f421086-79d7-44c5-ae60-f13b9b9013f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"equipment_model_id": "469fe582-c5b3-4f2b-8708-55174b093702",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "0a7bc9e5-ec91-4ecb-aecb-b00aa9f8085b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "4bcd8cb2-dfcc-4da4-96d6-d586fd3b59b7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "120d3d12-71b6-406f-9629-ea459adbd01f",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "49a31d0d-254c-455e-bd56-fc873f7517c9",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"equipment_family_id": "de30b27e-316e-457b-aba1-0305825570d7",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7f8d5d25-f9d6-4b83-be7a-5223e493def3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "9bb8b96b-80ee-4764-9530-73fc21f7d566",
"_parent_code": "sample string 6",
"sales_organization_id": "8f421086-79d7-44c5-ae60-f13b9b9013f9",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"date_in_production_since": "2026-08-17T10:58:58.1583031+00:00",
"date_out_of_production_since": "2026-08-17T10:58:58.1583031+00:00",
"date_end_support": "2026-08-17T10:58:58.1583031+00:00",
"sales_organization_id": "d74a17b7-58e1-4d2d-820f-57b705a15908",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+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-08-17T10:58:58.1583031+00:00"
},
"project_status_id": "fd980b1d-2364-4112-a838-bd9c74b20791",
"project_status_code": "sample string 10",
"project_status": {
"id": "910b3979-f66d-40a1-8649-a93281cf6e3c",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "f16e72dc-e891-46c8-9a0b-589f7d604a51",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"company_id": "12eb9e81-7e68-468d-8a34-112a8c956836",
"company_code": "sample string 12",
"db_address_id": "82b547b0-9e09-44ba-82c7-a0750786de41",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "00d5710f-d1cd-4ad0-b384-b11e063524bd",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "cc022605-5377-42aa-a4c4-6f33f9df3d90",
"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-08-17T10:58:58.1583031+00:00",
"date_create": "2026-08-17T10:58:58.1583031+00:00",
"date_update": "2026-08-17T10:58:58.1583031+00:00",
"updated_by_user_id": "ade10191-2107-45bb-8f33-80067ab307fa",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-08-17T10:58:58.1583031+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-08-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-08-17T10:58:58.1583031+00:00",
"date_last_job": "2026-08-17T10:58:58.1583031+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-08-17T10:58:58.1583031+00:00",
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00",
"is_mobile_installation": true
},
"job_type_id": "267a4100-1862-4f87-9cdd-d0998897e260",
"job_type_code": "sample string 7",
"job_type": {
"id": "6333065f-a46f-4800-875e-6705b53748f5",
"name": "sample string 2",
"sales_organization_id": "17f112f5-99ec-4ebc-ba28-0df5c9e6321e",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00",
"code": "sample string 7"
},
"job_priority_id": "0e5ba1e5-eea6-4c34-9705-4455688c43d2",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f934237f-1530-4f37-a2ff-8cde542add6b",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "dcf732b6-81af-4fed-93dc-1973d962467e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"job_status_id": "93d8574b-8554-4b3d-8632-31c0d2a1966e",
"job_status_code": "sample string 11",
"db_address_id": "2ece788c-e3a3-43d1-a042-c6401b7fbb40",
"contact_id": "ee1e9f1e-8e03-4331-bf6c-f7eee0526081",
"requested_by_company_id": "0f6aac23-23ba-4d49-bbe1-da991b761632",
"requested_by_contact_id": "deb748b0-f7ce-41a0-a840-b1226e46253b",
"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-08-17T10:58:58.1583031+00:00",
"due_date": "2026-08-17T10:58:58.1583031+00:00",
"date_create": "2026-08-17T10:58:58.1583031+00:00",
"date_update": "2026-08-17T10:58:58.1583031+00:00",
"date_closed": "2026-08-17T10:58:58.1583031+00:00",
"suggested_user_id": "d0fd67a1-04e1-4587-b619-8bf516861bf6",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "c528dafe-2816-40d1-8d21-440544bcad72",
"db_language_id": "26196e3e-b215-4bef-8877-a8fa475e169d",
"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-08-17T10:58:58.1583031+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "8669ba43-c5ca-4f31-b580-e8b0264e3926",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "2a384e3c-7ae1-4388-9c6b-912e2b03bce5",
"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": "54c331cf-5ee5-4540-a00d-f99c775042ba",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "53917392-7b08-4794-8ffc-55837db2a8fc"
},
"suggested_date_start": "2026-08-17T10:58:58.1583031+00:00",
"skill_id": "07132166-f5bc-4a7d-88e3-2390b453cc0a",
"skill_code": "sample string 32",
"skill": {
"id": "8c2c1b63-f70d-48da-be18-298a720a609d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "97710543-2b61-4c00-94f8-a1b61aeb62dd",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ba39a979-56de-49b9-87f4-5a65cc0b9f48",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ee40e559-8c3f-4775-9501-c843f5a14fce",
"db_currency_id": "10c791a8-f65f-4227-995c-bad57a917bc6",
"db_language_id": "e2d4d1e9-53c2-417d-9048-5e05405c82a3",
"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-08-17T10:58:58.1583031+00:00"
},
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "d5333a46-b7f0-4ef0-9fd6-7df88bd9d744",
"date_reported_by_company": "2026-08-17T10:58:58.1583031+00:00",
"id2": 36,
"company_id": "850828d0-96fd-4d3a-9e68-fccd131547d4",
"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": "42d49aeb-ac34-4cef-8a66-9fce2f839347",
"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-08-17T10:58:58.1583031+00:00"
},
"work_instruction_details_id": "750e3c0a-1f47-4208-98b8-c45fe0b97447",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fe7a6f1d-86b4-40b3-a4bd-ed528a2826b7",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "550c7e77-49f5-4279-bb7f-eb2999c47e4e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-08-17T10:58:58.1583031+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": "cff58768-c116-499d-8da7-8cff7a69c29d",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-08-17T10:58:58.1583031+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.