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": "d7fa8d16-51c2-4e40-afb1-638e4bbbbb93",
"jobs_id": "f600cad4-48fa-4a73-8725-e1ca513853c8",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "c8a74fb8-60e9-4b50-a95e-76196f403da2",
"_parent_id": "db414fbe-1d02-431f-b0d7-07951ec0ebec",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "c46b504e-67dc-4962-b5f4-fa271631baa4",
"project_reference_back_office": "sample string 5",
"project": {
"id": "079b7868-7f68-4a69-b4a3-7dfdef5d371f",
"_parent_id": "55756c70-6b21-4afe-aa3c-f84f05ba532d",
"root_parent_id": "fa09d504-88a3-48bd-8d34-08c578e372de",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "4eba0682-ee72-40c5-a5c9-dc9b98ff8b26",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2850c47b-2322-418f-8121-d13a3dc48f0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5f275ddd-2e52-437f-b284-ca6a90ee5b98",
"_parent_code": "sample string 6",
"sales_organization_id": "bd3d22d9-a567-4501-a204-47c7a5b9915d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"equipment_model_id": "53d14e19-eca1-4ab8-bf92-91cc28d0f5b8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6d6f66ff-12e1-440b-95a0-5ad9a56fa306",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "6d318370-4711-4907-bb5d-7d3bb61b5d62",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "9c250b48-4b41-4d4b-9da9-141c86af8223",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "a83502e4-a823-400e-97f8-d20dcf4b99f1",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"equipment_family_id": "adda7513-2e91-4be5-8529-a1f7b0b0c421",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2850c47b-2322-418f-8121-d13a3dc48f0b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5f275ddd-2e52-437f-b284-ca6a90ee5b98",
"_parent_code": "sample string 6",
"sales_organization_id": "bd3d22d9-a567-4501-a204-47c7a5b9915d",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"date_in_production_since": "2026-09-01T17:30:50.9305681+00:00",
"date_out_of_production_since": "2026-09-01T17:30:50.9305681+00:00",
"date_end_support": "2026-09-01T17:30:50.9305681+00:00",
"sales_organization_id": "a2004ce3-b4e1-4837-9b10-cc3a3353de01",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+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-01T17:30:50.9305681+00:00"
},
"project_status_id": "6d026407-7630-48ff-a101-5053d7e77e7b",
"project_status_code": "sample string 10",
"project_status": {
"id": "fc7abdb1-c84c-44c1-82e3-402df7e77ffd",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "557cd95b-1e89-4f07-b03a-d238af4fbdf8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"company_id": "7bcbfa14-c33f-4f30-a105-369f4427b6ee",
"company_code": "sample string 12",
"db_address_id": "4cb194ef-8a50-42c6-848f-5f54394ffb17",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "5a7bbd7d-65ce-4d4a-848f-2adfdbfd4adb",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "130ce38c-5141-4ef6-b5de-c35fcf835a78",
"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-01T17:30:50.9305681+00:00",
"date_create": "2026-09-01T17:30:50.9305681+00:00",
"date_update": "2026-09-01T17:30:50.9305681+00:00",
"updated_by_user_id": "8b752e34-83b1-4826-87c0-f48443232606",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-09-01T17:30:50.9305681+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-01T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-09-01T17:30:50.9305681+00:00",
"date_last_job": "2026-09-01T17:30:50.9305681+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-09-01T17:30:50.9305681+00:00",
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00",
"is_mobile_installation": true
},
"job_type_id": "9c81f541-fd19-4462-97e5-01a298d89925",
"job_type_code": "sample string 7",
"job_type": {
"id": "999f8f9f-431a-40f8-829f-d02967db46d6",
"name": "sample string 2",
"sales_organization_id": "51ff0fca-9e21-44e5-9435-da2aea288754",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00",
"code": "sample string 7"
},
"job_priority_id": "4dc80c62-0963-4cf4-bf93-c52e22eeb575",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "aa8f6db2-d774-4b05-8cbb-00cd7a93b925",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c6d895f8-cf7e-46d3-a0a1-b0ac906b8027",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"job_status_id": "7aeb594c-c5e4-4b70-adec-042de51d67f9",
"job_status_code": "sample string 11",
"db_address_id": "07e952e6-742e-45d5-a7e5-ab61bd9bb045",
"contact_id": "3a813300-ffb5-4156-b68e-2748bb437015",
"requested_by_company_id": "070e0b14-20cc-49d2-bb5c-62ec75baeaa8",
"requested_by_contact_id": "626abe1e-da90-4961-bd34-0d966b08fdab",
"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-01T17:30:50.9305681+00:00",
"due_date": "2026-09-01T17:30:50.9305681+00:00",
"date_create": "2026-09-01T17:30:50.9305681+00:00",
"date_update": "2026-09-01T17:30:50.9305681+00:00",
"date_closed": "2026-09-01T17:30:50.9305681+00:00",
"suggested_user_id": "0367e689-25cf-4e50-85a5-55196b6d6f65",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "f2912b21-b606-4a27-8e3c-cb77cbcd0681",
"db_language_id": "5371a0d0-e5e4-4212-acc0-f5f73b6f2b8f",
"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-01T17:30:50.9305681+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "ae4e4ca6-3ae9-4109-9872-bdcfe21fc5ae",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c45a5f68-3373-4112-a880-0ef02151d738",
"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": "a43cca99-c681-4711-b655-b299206389fa",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6a7fb468-5904-4353-a0f8-57ad4130779c"
},
"suggested_date_start": "2026-09-01T17:30:50.9305681+00:00",
"skill_id": "9f10d17b-bc66-4fec-97fd-f5b916a8c98c",
"skill_code": "sample string 32",
"skill": {
"id": "e1c84c78-fa5e-4675-8b4f-5e295e5b4b7b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4f71b783-1f4d-42c1-bb76-3871f62651b2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "3dbceda4-660f-485c-88c4-3f64ef81dc91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "4bf1b0c8-9c1a-432b-9044-d9259bdbfed2",
"db_currency_id": "0c7a01d8-b3d9-4cdf-9ed3-f55fecdda338",
"db_language_id": "43159ed6-2fb6-41c2-9f5f-da88c6d1c76c",
"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-01T17:30:50.9305681+00:00"
},
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "deb62f5a-3ac3-4d70-9421-7691ea42fb76",
"date_reported_by_company": "2026-09-01T17:30:50.9305681+00:00",
"id2": 36,
"company_id": "d4754424-d7cf-4eef-a80b-9d3cb8cdd120",
"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": "e2e0cf30-e7c8-430c-8597-13b78eab2bd7",
"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-01T17:30:50.9305681+00:00"
},
"work_instruction_details_id": "ced348ca-42e5-4f54-80a1-fa4d26300dd8",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "b7afb6bb-1fa3-4638-a10b-7b062cc48b29",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "5f5a7398-7bbc-4680-917f-22f029aaabe3",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-09-01T17:30:50.9305681+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": "1ee78ecb-9db0-4216-b085-d41b39aa519a",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-09-01T17:30:50.9305681+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.