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": "b2fe2a60-3caf-4728-8297-2283472e18ea",
"jobs_id": "791dce1c-bd1f-4635-bbc2-110d6a627964",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "9e0850fb-a2ac-411c-917f-1f0b542383d9",
"_parent_id": "7b5d15f5-39f8-490f-b1d9-b59a21f47a1f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "f9cff6f7-e6d7-41fd-ad85-cbc23358228e",
"project_reference_back_office": "sample string 5",
"project": {
"id": "da963eb2-b130-44dc-8357-4135fb1b7137",
"_parent_id": "18c8d034-cce8-45de-8678-582d97011d48",
"root_parent_id": "6b21e32f-7af8-4a70-ba0f-af4eed576a23",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "76b93af8-eb04-4575-b6ca-acdcf1c49604",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "13caee4a-3f49-44a7-9f08-61cb346d8e43",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9e59a08-b958-4890-ad6c-4b3144fafb44",
"_parent_code": "sample string 6",
"sales_organization_id": "44531bc2-a20c-474c-98b6-9f1ffe18193e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"equipment_model_id": "a4d8280c-831a-4747-b838-9e7e32806b87",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "1763e2a3-b9bb-4ab5-9337-c7c19ce6e3aa",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "b5d738a5-2eb5-4c18-a619-24b55b02977f",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "a88a0b77-de14-49e7-9606-0255734aba14",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a5358f02-e340-41eb-afdd-f4d4d46d1a62",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"equipment_family_id": "6aa985f2-de40-44fd-ab94-2d29eac152e0",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "13caee4a-3f49-44a7-9f08-61cb346d8e43",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "a9e59a08-b958-4890-ad6c-4b3144fafb44",
"_parent_code": "sample string 6",
"sales_organization_id": "44531bc2-a20c-474c-98b6-9f1ffe18193e",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"date_in_production_since": "2026-09-08T03:43:23.8411588+00:00",
"date_out_of_production_since": "2026-09-08T03:43:23.8411588+00:00",
"date_end_support": "2026-09-08T03:43:23.8411588+00:00",
"sales_organization_id": "29ae9665-d7dd-4dc6-ab2e-db67910866e4",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+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-09-08T03:43:23.8411588+00:00"
},
"project_status_id": "da2d1dab-73a0-4a3f-9769-aade93ab5e42",
"project_status_code": "sample string 10",
"project_status": {
"id": "9a8539ed-1a76-41ad-ba0e-4fb5f9eb1311",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "7ce15c08-2bf9-4d7d-a6f5-bbf45105afd5",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"company_id": "71ba131b-0183-4c39-ad4e-26c19f7c237d",
"company_code": "sample string 12",
"db_address_id": "49f88a82-d445-4dcb-ac66-452f0f303ced",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ba954ef9-4be1-4bd4-9d14-4fddd09e671f",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "0998e8e4-f76f-43ba-8c4c-58ac33f20dde",
"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-09-08T03:43:23.8411588+00:00",
"date_create": "2026-09-08T03:43:23.8411588+00:00",
"date_update": "2026-09-08T03:43:23.8411588+00:00",
"updated_by_user_id": "fd5a062a-9296-49ba-a21a-0b6c4183281f",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-08T03:43:23.8411588+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-09-08T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-08T03:43:23.8411588+00:00",
"date_last_job": "2026-09-08T03:43:23.8411588+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-08T03:43:23.8411588+00:00",
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00",
"is_mobile_installation": true
},
"job_type_id": "96baf6a5-d834-4730-bf36-201eb7b2fb41",
"job_type_code": "sample string 7",
"job_type": {
"id": "f7d2f8df-c241-47c5-8e35-8dcf75b0a2f6",
"name": "sample string 2",
"sales_organization_id": "5f424373-c856-4554-b776-5277b547dedf",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00",
"code": "sample string 7"
},
"job_priority_id": "003abb48-7d9b-4fe7-8fb0-215903b1faf8",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "ce5b35d2-244d-4f83-879d-22247dbbf6c7",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "56b798bf-85d9-4658-ad3e-1fdb11e17754",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"job_status_id": "336ae599-64a7-4021-965b-445fe376c245",
"job_status_code": "sample string 11",
"db_address_id": "9b3f6f5c-bc0a-43aa-936f-1618e1320abf",
"contact_id": "8fb2dad2-3551-4c7a-b190-9ffa214cdf6c",
"requested_by_company_id": "56cef2e4-1a67-4ece-b78a-b4773d5b7949",
"requested_by_contact_id": "75c84c40-7d9a-4330-8885-724c88f34dbd",
"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-09-08T03:43:23.8411588+00:00",
"due_date": "2026-09-08T03:43:23.8411588+00:00",
"date_create": "2026-09-08T03:43:23.8411588+00:00",
"date_update": "2026-09-08T03:43:23.8411588+00:00",
"date_closed": "2026-09-08T03:43:23.8411588+00:00",
"suggested_user_id": "81b67230-9c99-4eaf-9789-9929b4e25ed8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "8e72bab8-ae3e-42d6-891c-df16c1da3323",
"db_language_id": "c769ddc7-be39-4cae-a004-b99281a935d7",
"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-09-08T03:43:23.8411588+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "b6d53068-e591-4112-b110-d8c1a6cfb1aa",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "99fcc6d3-647b-4974-beef-e5b061e17db8",
"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": "3462a7e2-40c9-446b-9c67-e9a48ce10d86",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "9b9fbfcd-8258-442d-86a8-05d73b414a4b"
},
"suggested_date_start": "2026-09-08T03:43:23.8411588+00:00",
"skill_id": "4da5b1a1-7958-4a5e-bd6c-f930e53b9691",
"skill_code": "sample string 32",
"skill": {
"id": "9a375900-b776-4767-a80b-95a4c2d4ea01",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "74c9778e-1acf-4c3e-92df-7aeb34ae682f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "0d2e98e0-0b8e-4d8f-a655-88aa549a0f0e",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "5ebebe21-92f1-4dad-89bf-5b2b556e961e",
"db_currency_id": "0bd45954-b00b-4b60-9b4a-984d4ac01eb9",
"db_language_id": "70f8783a-05bd-4fd8-8b1a-e0fa236cc2a9",
"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-09-08T03:43:23.8411588+00:00"
},
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "dfa089d3-1016-4c11-8633-2767f672a04f",
"date_reported_by_company": "2026-09-08T03:43:23.8411588+00:00",
"id2": 36,
"company_id": "fb0c05b2-daaa-4fee-b97b-c1a167fe5ca4",
"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": "5ba85ffe-838e-4f2d-b8b0-c1800eae275f",
"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-09-08T03:43:23.8411588+00:00"
},
"work_instruction_details_id": "3623c6e9-0e92-4dbb-a993-ac9aa10b9455",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "ffb7b077-2512-4393-a4de-d526a811d44c",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "6ca92775-8c3c-4e8b-8235-21b23ad1a123",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-08T03:43:23.8411588+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": "c1ef4c6c-0829-421a-b802-41af2224cfff",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-08T03:43:23.8411588+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.