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": "f30a51f2-7b02-4821-b09d-8df7786750ac",
"jobs_id": "fac4495d-4e93-4885-bc35-2d32e7def5cd",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "a3db8460-56c8-4171-8b87-41c4537cb46d",
"_parent_id": "1fc520a0-bc06-44ff-9cda-40b1e429acf0",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "21fbb5fc-baf9-40b1-a8f7-0d547a3cb9f3",
"project_reference_back_office": "sample string 5",
"project": {
"id": "f28ea32c-62f4-41d0-a36d-9355b2ce29e5",
"_parent_id": "a5d2423c-da2a-4c1c-9192-be5722e85807",
"root_parent_id": "81b78ee0-c379-4a76-9ab0-45021e062f15",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "37c47286-c0c2-4499-b9bf-f443ce37482a",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "c2bd5a2a-c9cc-4f54-bb6a-35393fac41b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "248a2cd9-2cec-4237-a189-76ad8d06fdb0",
"_parent_code": "sample string 6",
"sales_organization_id": "9cfffb23-c538-4def-8db4-e8a545c0d751",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"equipment_model_id": "c9e71a48-9971-4f5e-b794-526d79d7b061",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6995e0cc-0240-4e31-a6ca-26e159ed5a9b",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "10b22b62-da89-48d5-a73e-cfb674deefee",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "cb37ca1d-bdf9-4e1f-a356-67552912bfe0",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "40e8b661-2cb7-448c-b6bd-30cd8e6c4669",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"equipment_family_id": "f6023c52-e448-42b1-aafd-91e72ad269fc",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "c2bd5a2a-c9cc-4f54-bb6a-35393fac41b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "248a2cd9-2cec-4237-a189-76ad8d06fdb0",
"_parent_code": "sample string 6",
"sales_organization_id": "9cfffb23-c538-4def-8db4-e8a545c0d751",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"date_in_production_since": "2026-07-18T02:53:48.6062868+00:00",
"date_out_of_production_since": "2026-07-18T02:53:48.6062868+00:00",
"date_end_support": "2026-07-18T02:53:48.6062868+00:00",
"sales_organization_id": "32faccbc-39d4-4384-84e7-017e17d10a3f",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+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-07-18T02:53:48.6062868+00:00"
},
"project_status_id": "cf2691a4-5f72-49a7-9b64-fde10c33c1f1",
"project_status_code": "sample string 10",
"project_status": {
"id": "e41184db-0eac-4194-8f0e-d435681e8823",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "738fcdfa-db9c-47a5-a2be-a6aa2dcbbdac",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"company_id": "95def38b-6352-4abd-ba89-ea381d2ae5e7",
"company_code": "sample string 12",
"db_address_id": "611442f1-44a2-44e5-96b4-c7cb9e8a4679",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8633060c-8104-4895-a44c-b870d16b27a6",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "15f89e36-d1c9-4ff1-bd13-c7df31e230ed",
"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-07-18T02:53:48.6062868+00:00",
"date_create": "2026-07-18T02:53:48.6062868+00:00",
"date_update": "2026-07-18T02:53:48.6062868+00:00",
"updated_by_user_id": "4f48b60c-1e0a-497d-bd2c-ad6f7e0fe9c4",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-07-18T02:53:48.6062868+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-07-18T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-07-18T02:53:48.6062868+00:00",
"date_last_job": "2026-07-18T02:53:48.6062868+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-07-18T02:53:48.6062868+00:00",
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00",
"is_mobile_installation": true
},
"job_type_id": "e01843ea-4880-469f-bfae-5bc0e95e8e85",
"job_type_code": "sample string 7",
"job_type": {
"id": "23c6dec9-a4ef-4092-b090-4d4170212e97",
"name": "sample string 2",
"sales_organization_id": "8b4139a5-ed93-485e-a71c-2a8f9714c594",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00",
"code": "sample string 7"
},
"job_priority_id": "1b7e347e-3a23-44af-8290-60ee77923eb7",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "9404c402-d682-4c70-948c-329e213d594d",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "4f94fef1-01dd-4324-a2f3-18bd90486919",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"job_status_id": "3b174f4f-7c0d-4f57-b87b-b627efc744c7",
"job_status_code": "sample string 11",
"db_address_id": "889e8001-a4c2-4f9a-b1cf-51592ad0622f",
"contact_id": "85e1cb5d-efd4-4107-b125-a5cadb1a482b",
"requested_by_company_id": "3c6f223a-866d-412d-a9a3-6226485ba4fd",
"requested_by_contact_id": "65bab286-1f2d-49f6-a068-7f639b86f92f",
"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-07-18T02:53:48.6062868+00:00",
"due_date": "2026-07-18T02:53:48.6062868+00:00",
"date_create": "2026-07-18T02:53:48.6062868+00:00",
"date_update": "2026-07-18T02:53:48.6062868+00:00",
"date_closed": "2026-07-18T02:53:48.6062868+00:00",
"suggested_user_id": "e213da0a-88b2-4601-baa4-f93cc7649ab5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "aaf1ab16-65b6-48cb-b0b6-7a981790ebb0",
"db_language_id": "501f4365-a80f-4b7b-9480-44d10b045d7e",
"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-07-18T02:53:48.6062868+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "9b7ad3dd-9d4c-466a-b478-90e16d524708",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "e056ccfe-f9ab-4cb4-9c63-9189600aef01",
"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": "73a25661-3bcc-4d01-9f28-7286148658c6",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "3460b85f-f97e-4f3b-8da9-d26a86c6ce72"
},
"suggested_date_start": "2026-07-18T02:53:48.6062868+00:00",
"skill_id": "e0a11dcc-de95-4b4c-b627-cf53c3492965",
"skill_code": "sample string 32",
"skill": {
"id": "f71c625f-8aee-4e30-90ad-b6a8104faf3f",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "b301a845-3dfc-4808-a393-d9fb8034e377",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "25fb3214-92aa-474a-b4d6-b8e563bdf35a",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "252c2752-45d2-46fd-b8cc-00df8f752725",
"db_currency_id": "06e074dd-d139-4ece-86e8-a27e3b289aa8",
"db_language_id": "f3f421d5-390f-42ec-98f1-f3ca2403b6f2",
"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-07-18T02:53:48.6062868+00:00"
},
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9c39beb3-5fc2-4057-b3b0-aace84094133",
"date_reported_by_company": "2026-07-18T02:53:48.6062868+00:00",
"id2": 36,
"company_id": "1b19285a-9fd1-4865-ab81-d36e2d630924",
"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": "86e55c3e-403b-45d5-805e-5bf0dba81574",
"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-07-18T02:53:48.6062868+00:00"
},
"work_instruction_details_id": "b7a24d52-4f98-433d-823a-4356135f42bd",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "69c6ed96-c9bd-4974-856f-e335ab41eadc",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "761dd3da-8b6e-460f-b6f5-208b25573f7a",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-07-18T02:53:48.6062868+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": "f3bba006-89a5-44c7-b22c-db14f54203de",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-07-18T02:53:48.6062868+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.