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": "0b9484cf-3c8c-4be1-9028-6abb5406ca84",
"jobs_id": "ecf75147-7fb8-41c1-963f-79d7ee2ab08b",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "0a45d115-963a-43e6-84b8-808923ba07ca",
"_parent_id": "10b1a249-0d45-4674-aa43-fff67852c8b8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "8280074d-8ab0-47d3-bd08-f859221876d5",
"project_reference_back_office": "sample string 5",
"project": {
"id": "135d8062-acb2-4c65-951a-81a03944795d",
"_parent_id": "ebcd0b19-8441-48f9-aeb7-17e83a229c6c",
"root_parent_id": "0d10198f-3350-4bd7-a4c7-639169c87d26",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "f3c688c8-ed52-40b7-a508-9fe24a1798f9",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "f0d971dc-0627-4cdf-87d7-79240c1b5cee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "705fd9e9-843a-4b6e-9046-0af3a9dd9404",
"_parent_code": "sample string 6",
"sales_organization_id": "bc8d8b55-5406-471f-b215-77e8ecb14ca5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"equipment_model_id": "93f78900-e10a-43a8-a20b-b086d9395006",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "724660d0-1528-40d1-ae16-5e0aba489d82",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "39afa76e-cc35-49bf-9675-ee1e89103e92",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "8b5969ee-1ba7-4dd3-bc91-0fc4af895137",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fa663631-6cfb-4bbc-9d16-67743d482eae",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"equipment_family_id": "f1a992c1-413a-4d40-aa2a-b387e4072dea",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "f0d971dc-0627-4cdf-87d7-79240c1b5cee",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "705fd9e9-843a-4b6e-9046-0af3a9dd9404",
"_parent_code": "sample string 6",
"sales_organization_id": "bc8d8b55-5406-471f-b215-77e8ecb14ca5",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"date_in_production_since": "2026-04-29T13:09:21.1259033+00:00",
"date_out_of_production_since": "2026-04-29T13:09:21.1259033+00:00",
"date_end_support": "2026-04-29T13:09:21.1259033+00:00",
"sales_organization_id": "055e2835-3015-400b-a649-076aae5f21e2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+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-04-29T13:09:21.1259033+00:00"
},
"project_status_id": "8c710d3d-3240-4f34-93c7-a6918b94e52e",
"project_status_code": "sample string 10",
"project_status": {
"id": "551957e4-f94f-4bcc-a858-cdca424aacb6",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "8717648b-bf21-4e49-9aab-4d8487d4130d",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"company_id": "946cb20f-e5b6-4431-9b9e-daa5a8fd9e1d",
"company_code": "sample string 12",
"db_address_id": "0cc7a8f7-bfd0-437c-8504-99e9c97176b8",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "116d25a5-f9ed-45d8-af5b-a7fab9175850",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "5543c3df-6296-4518-b4e0-66ba3d499813",
"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-04-29T13:09:21.1259033+00:00",
"date_create": "2026-04-29T13:09:21.1259033+00:00",
"date_update": "2026-04-29T13:09:21.1259033+00:00",
"updated_by_user_id": "6c86dc3c-39cb-4bdf-9bd4-744803e38def",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-04-29T13:09:21.1259033+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-04-29T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-04-29T13:09:21.1259033+00:00",
"date_last_job": "2026-04-29T13:09:21.1259033+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-04-29T13:09:21.1259033+00:00",
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00",
"is_mobile_installation": true
},
"job_type_id": "29ed13ef-52a8-4b73-a19d-6e35b017233d",
"job_type_code": "sample string 7",
"job_type": {
"id": "1fc82eef-ef90-4a0e-b9f8-5ef8dbf7a780",
"name": "sample string 2",
"sales_organization_id": "125a331b-26d8-48b6-a28c-d9eabf7a4514",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00",
"code": "sample string 7"
},
"job_priority_id": "756a2282-e192-4cba-abc4-e205ef0a73f1",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "fdf6082c-72df-419e-a9ee-4dec583b2540",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "189248f0-035b-42fa-bf1d-83df07c7f957",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"job_status_id": "3ef69c60-7862-491d-aa13-d0e850726930",
"job_status_code": "sample string 11",
"db_address_id": "74f2cc1c-535e-4609-96b2-938b2b242d3e",
"contact_id": "85d80bc0-2f37-4388-9289-8e270ae9a717",
"requested_by_company_id": "4851b6f9-167e-47f0-86f2-0d83f1a2ac79",
"requested_by_contact_id": "1fe6430e-f270-4517-b263-909d9564cda8",
"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-04-29T13:09:21.1259033+00:00",
"due_date": "2026-04-29T13:09:21.1259033+00:00",
"date_create": "2026-04-29T13:09:21.1259033+00:00",
"date_update": "2026-04-29T13:09:21.1259033+00:00",
"date_closed": "2026-04-29T13:09:21.1259033+00:00",
"suggested_user_id": "8e5d3b0b-6012-44e0-bf09-3923d535c7aa",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ef67e4f7-483d-4e53-aa50-ef41649f2e9e",
"db_language_id": "b2f51733-dd5e-418d-a5b8-904a8f56d264",
"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-04-29T13:09:21.1259033+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "6d4e8142-8321-426e-8a54-96e4da9245be",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "c7c7a31e-9f88-438a-9286-3cb7f4461bc5",
"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": "6bba9ff9-5c63-4970-8466-c060c6d0f468",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "cf7d9a1a-ad5e-4392-a6ea-b47debf484bd"
},
"suggested_date_start": "2026-04-29T13:09:21.1259033+00:00",
"skill_id": "19af13ff-2e78-4219-a845-5784e327eb68",
"skill_code": "sample string 32",
"skill": {
"id": "fc4383c1-194d-4f7c-9427-994dbfe4f545",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "671871cf-6933-43c5-a337-ad464c4547f2",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "a4aecfa2-0a75-4b66-b4d3-e43bceaefdda",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "8b01a498-5108-4833-bcc6-ba054d74fe15",
"db_currency_id": "844790d9-4a28-41af-b62e-28ee4782ab01",
"db_language_id": "11a6bc98-20d2-4552-82ef-945c07882d2d",
"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-04-29T13:09:21.1259033+00:00"
},
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "e0544b1d-db68-45c1-8212-1b29efad58a0",
"date_reported_by_company": "2026-04-29T13:09:21.1259033+00:00",
"id2": 36,
"company_id": "6c7b4ebd-cb37-4018-97ca-9894fe85e6a8",
"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": "3d0fdda5-358a-4b80-96e4-98f3886d6c5d",
"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-04-29T13:09:21.1259033+00:00"
},
"work_instruction_details_id": "1337c215-6abd-40f1-b96f-96bf3e2bacde",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "2bc52d8b-515a-4557-b5b4-4b407f29700e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "ab8aa37c-6e59-4dd9-bf4d-455a8012b08f",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-04-29T13:09:21.1259033+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": "7669da59-65fd-4cea-ba54-8c842ef4cec7",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-04-29T13:09:21.1259033+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.