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": "6986212f-e223-42e0-84e3-9825f0214a2d",
"jobs_id": "3cb61746-0cdc-4a08-94a5-3b68caf2df0a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "7f438564-bd35-4548-8901-48870e0833a7",
"_parent_id": "9de1b506-c1e6-44b9-aa31-780c9a0b860f",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "7e844f4f-e3e9-4274-abd7-684097a11b40",
"project_reference_back_office": "sample string 5",
"project": {
"id": "0afc4a89-e6a6-411e-b052-d97053313f8a",
"_parent_id": "f53eba35-df3d-45d5-9755-49d9c9efcedc",
"root_parent_id": "0983f966-20c2-4861-a118-4a51cb7a2039",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "ede34fca-f7c7-405f-bd6e-d35a67832ec5",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2cc77425-8aab-4d4a-b0d1-d56183113d02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5aec46f7-9bb4-417f-b805-69674305d7b7",
"_parent_code": "sample string 6",
"sales_organization_id": "822313dd-abf3-4b62-bb12-22728b6d8f74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"equipment_model_id": "baac9d26-6997-43ab-9c87-a4830eaa42d6",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "6f32a231-5e4b-4e3b-8395-25f7de07d920",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "1b4195b2-7811-4331-9b0b-e05571c4eecc",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "220bd90b-bb51-46a6-9d20-34857b0d810e",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "fe2ccbd6-17e8-421d-b19b-d3948dc12ff7",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"equipment_family_id": "c4a78e66-2ed6-4ef9-adb4-3d24f526697e",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2cc77425-8aab-4d4a-b0d1-d56183113d02",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "5aec46f7-9bb4-417f-b805-69674305d7b7",
"_parent_code": "sample string 6",
"sales_organization_id": "822313dd-abf3-4b62-bb12-22728b6d8f74",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"date_in_production_since": "2025-11-04T13:29:30.396001+00:00",
"date_out_of_production_since": "2025-11-04T13:29:30.396001+00:00",
"date_end_support": "2025-11-04T13:29:30.396001+00:00",
"sales_organization_id": "d478f650-8107-4b07-886c-77404b243122",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+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": "2025-11-04T13:29:30.396001+00:00"
},
"project_status_id": "e3a0d7b0-531e-439f-a54f-43554994ea8a",
"project_status_code": "sample string 10",
"project_status": {
"id": "387f5287-342c-4d89-88ac-cc81a7e45d42",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "efa75ef8-814c-497c-832d-c094d8186fef",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"company_id": "d99740f8-0ed1-4db6-b975-97edd838e121",
"company_code": "sample string 12",
"db_address_id": "d9f1f875-1e02-4df7-9f29-980400a88232",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "83298009-0ac0-4ad5-a927-8e68eea5edc4",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "b23fc6db-9aac-4cc8-a138-22a75088a20f",
"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": "2025-11-04T13:29:30.396001+00:00",
"date_create": "2025-11-04T13:29:30.396001+00:00",
"date_update": "2025-11-04T13:29:30.396001+00:00",
"updated_by_user_id": "2017b9ac-1d7f-4107-bfea-d13f87cca5f9",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-04T13:29:30.396001+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": "2025-11-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-04T13:29:30.396001+00:00",
"date_last_job": "2025-11-04T13:29:30.396001+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-04T13:29:30.396001+00:00",
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00",
"is_mobile_installation": true
},
"job_type_id": "8d6c8537-b7a1-4375-a4c3-cc9278d866d4",
"job_type_code": "sample string 7",
"job_type": {
"id": "4cef7f7f-342b-40d9-baf9-31023220735e",
"name": "sample string 2",
"sales_organization_id": "d0e05190-1059-4e83-b3ef-560b5d905993",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00",
"code": "sample string 7"
},
"job_priority_id": "9c49e85e-47a8-4fa7-9270-16b8d804d8a0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "00d9e1df-ed43-4909-ad98-e13c00df1501",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "c9a575a4-756e-42d2-aafd-c32fdc5f7c7f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"job_status_id": "ae85a635-936e-4864-8a15-b6ebef74f779",
"job_status_code": "sample string 11",
"db_address_id": "8f765285-a2cb-4394-b56d-6f3e5280f1c7",
"contact_id": "485480a8-a2d3-46bb-8aa5-478809269e92",
"requested_by_company_id": "1931695e-4e0f-45b7-9f4d-8551349a281b",
"requested_by_contact_id": "68baf8f7-04e6-42fc-8987-3f7b58d1e997",
"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": "2025-11-04T13:29:30.396001+00:00",
"due_date": "2025-11-04T13:29:30.396001+00:00",
"date_create": "2025-11-04T13:29:30.396001+00:00",
"date_update": "2025-11-04T13:29:30.396001+00:00",
"date_closed": "2025-11-04T13:29:30.396001+00:00",
"suggested_user_id": "4ce0382b-f880-496e-aef8-419ee4e94bf2",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "69f2188d-4a6a-4136-9713-17d95f201228",
"db_language_id": "482a8659-3256-42cc-901e-aa0eaefdc9b5",
"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": "2025-11-04T13:29:30.396001+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "3431c67b-f52a-4dec-b95c-60ea5420e39d",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "4d61bcbf-31a5-41e1-a00a-9f908ae4aebc",
"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": "f8430a46-4f58-414e-8d95-f1027baacb05",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "f5dc0f52-c3de-4ae1-9d55-80b466124f69"
},
"suggested_date_start": "2025-11-04T13:29:30.396001+00:00",
"skill_id": "01f35f37-4186-4a4b-a3fe-3ab1b442779d",
"skill_code": "sample string 32",
"skill": {
"id": "408e9c00-99bc-4aea-807a-e8703d3dfc5b",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "e41a3452-576e-4fe2-a422-be408ad12b26",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "7ce90903-d6ea-4642-ae55-75248ed38a29",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "0289cba9-522b-47e0-9e0e-1706a9c18620",
"db_currency_id": "444e4458-251e-488f-b440-f484d28829c9",
"db_language_id": "93e12994-befd-41d0-a7be-cbca59d02eb4",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f1cb69c9-22b6-418f-ae25-4aa935518581",
"date_reported_by_company": "2025-11-04T13:29:30.396001+00:00",
"id2": 36,
"company_id": "36530328-6706-4002-9d3c-8c5a91930fc7",
"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": "2d9f0411-a87c-400b-8425-4a84f6e7b9fc",
"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": "2025-11-04T13:29:30.396001+00:00"
},
"work_instruction_details_id": "5b026d4d-e8d5-45d7-a7e3-1a9f2660de92",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "35eb862c-acd6-4336-9d83-a2bb8ae41141",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fbbc8cdb-72f4-4f34-997e-9fcb09f341a9",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-04T13:29:30.396001+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": "ce209e83-8a57-492d-bb32-7acdfe7485c1",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-04T13:29:30.396001+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.