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": "5f8d7c59-3bd4-4eaf-bc3a-c12ca44f315d",
"jobs_id": "2cff567d-af34-45b5-b7bf-86e312baa960",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "5d54c371-cc5b-48ba-b202-e92a8152c9c7",
"_parent_id": "93b8c611-46ca-4731-a57c-52026c66fffa",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "ba3ad629-0b2d-4620-8bcf-9ffa6c95bf8c",
"project_reference_back_office": "sample string 5",
"project": {
"id": "70d55bd7-1314-46a9-88f8-81c3d282b266",
"_parent_id": "7f9691b4-7cfd-4fd7-bafc-02112a78c274",
"root_parent_id": "a67699d4-c211-4420-a578-823ed24cd35e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1f37cbeb-c33a-4b66-90a1-94c43ccadf60",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "7220a5cb-463d-4547-8ea5-e92e0f6bc6b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8d38a333-bc94-4225-ac34-26a1a6924e5c",
"_parent_code": "sample string 6",
"sales_organization_id": "ce09360e-fbfa-4e40-8f10-3d4e92b6580e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"equipment_model_id": "a69c57ec-9b7a-4264-9f40-68f08d71f4b3",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "ac8394d6-29fd-480a-b6fa-8e79cebc25a0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b673bf03-0609-4b5e-b653-7b856784582f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "3eca0866-813d-4f3d-bea4-b77e1fe68cf3",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "de41be59-4571-4a0e-af28-d99bd83abd55",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"equipment_family_id": "c748c190-36be-4225-a5f8-a8f5f851c6d6",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "7220a5cb-463d-4547-8ea5-e92e0f6bc6b3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "8d38a333-bc94-4225-ac34-26a1a6924e5c",
"_parent_code": "sample string 6",
"sales_organization_id": "ce09360e-fbfa-4e40-8f10-3d4e92b6580e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"date_in_production_since": "2026-01-26T07:11:54.4732388+00:00",
"date_out_of_production_since": "2026-01-26T07:11:54.4732388+00:00",
"date_end_support": "2026-01-26T07:11:54.4732388+00:00",
"sales_organization_id": "67f51a97-203e-4ef8-ae66-63b2fbb97030",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+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-26T07:11:54.4732388+00:00"
},
"project_status_id": "608dc18d-616b-4c08-bdb9-e28680d9160f",
"project_status_code": "sample string 10",
"project_status": {
"id": "d55cae62-f308-4310-81b0-5fc8c2fbb7e8",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "5f4be265-4e12-4a61-9491-a072ae256a7c",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"company_id": "4bf62a65-2fa7-4192-85c3-1c3dbe6b47d4",
"company_code": "sample string 12",
"db_address_id": "c3f7964b-ceac-4d54-8109-de436d03ef60",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ff9b6e59-c8cc-4c90-903a-607ea4950fd0",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "4bd015d7-43d0-4406-9e68-8b7f9585d4c3",
"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-26T07:11:54.4732388+00:00",
"date_create": "2026-01-26T07:11:54.4732388+00:00",
"date_update": "2026-01-26T07:11:54.4732388+00:00",
"updated_by_user_id": "e73da4f5-99e7-40e4-a41b-aff05ce9f21e",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-01-26T07:11:54.4732388+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-26T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-01-26T07:11:54.4732388+00:00",
"date_last_job": "2026-01-26T07:11:54.4732388+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-01-26T07:11:54.4732388+00:00",
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00",
"is_mobile_installation": true
},
"job_type_id": "1c55757f-48c8-479c-8975-e0c15002023b",
"job_type_code": "sample string 7",
"job_type": {
"id": "1e6ba4e7-8e57-459f-aaa4-a9ef02cb3c12",
"name": "sample string 2",
"sales_organization_id": "994e5fc5-4b14-45cf-ab52-8cccc253ec88",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00",
"code": "sample string 7"
},
"job_priority_id": "bd6d642b-8a81-45f4-9305-9a04eca21c1d",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "2f551027-be8b-46e6-bc2d-7b2f3dbf1d0a",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "d5582fca-de1c-4503-a069-c604bd330ecb",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"job_status_id": "78a435ce-0f8b-43f6-a5b1-d9f17af4d6da",
"job_status_code": "sample string 11",
"db_address_id": "7eaa626e-c1d4-4388-ae96-38b4e9e792ca",
"contact_id": "8acf8c4a-d010-4d16-844a-7f8e28f70508",
"requested_by_company_id": "7998a089-e9ea-4a0b-bb33-8bd138399647",
"requested_by_contact_id": "5a77d553-5f03-4e70-ab3f-ffc15fdceb53",
"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-26T07:11:54.4732388+00:00",
"due_date": "2026-01-26T07:11:54.4732388+00:00",
"date_create": "2026-01-26T07:11:54.4732388+00:00",
"date_update": "2026-01-26T07:11:54.4732388+00:00",
"date_closed": "2026-01-26T07:11:54.4732388+00:00",
"suggested_user_id": "ce7551d0-e08c-49f6-9cdb-8466bd295d8c",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f6d145f1-94fa-4031-90b4-0df2e0fe545e",
"db_language_id": "9c20c6b3-dcc5-47f2-ae40-893024c72d9c",
"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-26T07:11:54.4732388+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "d7a35933-7791-40f3-9ba0-1957b957f8c0",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "96735495-d88a-4546-8cf0-3c8132d6a4ca",
"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": "90c459a9-149b-4f31-be97-4205ae2cd12d",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f1c1195b-5419-42f6-8f80-ba06b8a03d87"
},
"suggested_date_start": "2026-01-26T07:11:54.4732388+00:00",
"skill_id": "99dc8488-beb5-4045-97e9-28d251f9138d",
"skill_code": "sample string 32",
"skill": {
"id": "cbf3f001-f173-41f4-bb6d-d3ee381919f4",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4a67faf2-54fb-419b-aa7b-5f4961748bd1",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "d99cdb24-abf0-45c2-a190-4e8080fd14b2",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "e9a05cad-faa8-45ad-bcc4-889449290560",
"db_currency_id": "859ca1fe-280c-452d-8737-3f146d6ed335",
"db_language_id": "f0fae364-0cf0-4602-802f-332540efb6c7",
"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-26T07:11:54.4732388+00:00"
},
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "73a4568c-35c7-4f0e-937d-88d6a34144d1",
"date_reported_by_company": "2026-01-26T07:11:54.4732388+00:00",
"id2": 36,
"company_id": "f06d6ab0-ce15-40d3-b67c-b0281c382ffd",
"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": "035ee244-e877-451c-9211-c7022b3489c6",
"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-26T07:11:54.4732388+00:00"
},
"work_instruction_details_id": "d32c5371-7dce-4764-ad99-02550e654648",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "fedfcced-286e-42b5-bd32-4e49a61587ee",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "c150a24e-6d6c-4285-8870-ef86341728a3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-01-26T07:11:54.4732388+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": "d56ac47c-0fd8-41ed-8043-40f71874410e",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-01-26T07:11:54.4732388+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.