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": "e9ac8d98-baa8-4432-82a2-2c8886f6517e",
"jobs_id": "f0423fc5-c22a-412f-a99d-1ba900fa2aaa",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "ca16c623-b8e7-4cfc-92d2-b22ba4e6fecb",
"_parent_id": "bed62988-1353-44fb-95a7-86e28703d2e8",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "384c2d05-3dc4-4059-b0e2-044f1d0af44f",
"project_reference_back_office": "sample string 5",
"project": {
"id": "e1b6762e-0714-49b6-b3bb-521f2a432e13",
"_parent_id": "1b2dd701-97c5-4326-a815-2d79f95db6ac",
"root_parent_id": "d6487928-7108-4b38-a28a-bc038674952d",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "937bc157-098d-49c9-bca2-fa05154fdf41",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b35dde43-2914-42af-834e-cd1a06cd2031",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09f3138e-5a11-4f6a-ad3c-024435c1010e",
"_parent_code": "sample string 6",
"sales_organization_id": "1f10dc43-cc2b-4524-8117-5fc416483773",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"equipment_model_id": "7a49280d-9752-4668-a712-010408fe17c8",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "d0716b6a-6930-48a4-b147-1501adb9dec4",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "8f9b116d-7b5d-454a-ba8b-f6682acbe949",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "caa7693d-c9d9-49d2-a8fe-899e5931c194",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "f8733aab-c1cd-44a7-b0e9-b3b79c310659",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"equipment_family_id": "8a71f17e-4b3a-4aaa-91ee-2ae96bd44dbe",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b35dde43-2914-42af-834e-cd1a06cd2031",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "09f3138e-5a11-4f6a-ad3c-024435c1010e",
"_parent_code": "sample string 6",
"sales_organization_id": "1f10dc43-cc2b-4524-8117-5fc416483773",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"date_in_production_since": "2025-10-04T08:36:25.5481603+00:00",
"date_out_of_production_since": "2025-10-04T08:36:25.5481603+00:00",
"date_end_support": "2025-10-04T08:36:25.5481603+00:00",
"sales_organization_id": "6c0ca1db-37af-412a-a68a-cf4aa2240d8c",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+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-10-04T08:36:25.5481603+00:00"
},
"project_status_id": "80a245ae-02a0-47b0-a442-c602cb1963ba",
"project_status_code": "sample string 10",
"project_status": {
"id": "a404af75-7480-45f6-bbb5-333889abae01",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "df7c7465-baa3-430b-a549-6af998d73d2a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"company_id": "cfd3f553-7489-4c7d-801f-39684ff25cdb",
"company_code": "sample string 12",
"db_address_id": "770a49c0-6de5-48e3-b108-cce2dca4fc03",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "8a07300b-184b-49f4-ad10-1c3a99a44c0c",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "c3fd56e3-de3f-4132-b7a8-c492976f445e",
"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-10-04T08:36:25.5481603+00:00",
"date_create": "2025-10-04T08:36:25.5481603+00:00",
"date_update": "2025-10-04T08:36:25.5481603+00:00",
"updated_by_user_id": "bfaa8305-6918-4fb9-b94f-62080d60e5d5",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-10-04T08:36:25.5481603+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-10-04T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-10-04T08:36:25.5481603+00:00",
"date_last_job": "2025-10-04T08:36:25.5481603+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-10-04T08:36:25.5481603+00:00",
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00",
"is_mobile_installation": true
},
"job_type_id": "a0917a5d-b5b5-483b-ba9c-c94ce367c65e",
"job_type_code": "sample string 7",
"job_type": {
"id": "e18bd423-f8ca-4b0e-ad0a-baa7d9c47e77",
"name": "sample string 2",
"sales_organization_id": "ac446aa6-00cb-447c-be3e-fa47d1496385",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00",
"code": "sample string 7"
},
"job_priority_id": "4656bc7c-e11e-4e5f-985a-446c0bcc2311",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "f93c760c-205d-4dc1-b5c5-84942951c383",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "cbd149c2-3f09-4bb1-9d67-7245e3ace5b0",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"job_status_id": "6e0c5f45-43f3-4b75-839c-aba8cab0fa8b",
"job_status_code": "sample string 11",
"db_address_id": "f92072be-1a82-4e7b-80df-d8a66337cc80",
"contact_id": "04193845-734a-4415-a80b-4b0c8df01fd8",
"requested_by_company_id": "adf687db-9cfe-4ccc-b0fd-a637b8ab5dbf",
"requested_by_contact_id": "b0939fa8-61b9-4bf0-9513-12af10bdb3f9",
"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-10-04T08:36:25.5481603+00:00",
"due_date": "2025-10-04T08:36:25.5481603+00:00",
"date_create": "2025-10-04T08:36:25.5481603+00:00",
"date_update": "2025-10-04T08:36:25.5481603+00:00",
"date_closed": "2025-10-04T08:36:25.5481603+00:00",
"suggested_user_id": "09d14c63-bd9f-49e3-9cf2-8895801a8c07",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "ec7d22df-7ff2-45da-80bb-ddcfe2da9dc0",
"db_language_id": "2d8a967b-d7fd-40dd-861d-7e343752f155",
"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-10-04T08:36:25.5481603+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "c4c37936-892a-4754-987a-6670c59a509f",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "f0ab2b4f-68ad-4adf-9ce7-f051e2b9cc9f",
"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": "839104ad-0cec-4b27-96a5-1d8a5eededfc",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "b15ef5c5-9c43-4c9f-8b04-3a371dd659f7"
},
"suggested_date_start": "2025-10-04T08:36:25.5481603+00:00",
"skill_id": "a28b6750-3eff-4d03-98ca-19f766b80c86",
"skill_code": "sample string 32",
"skill": {
"id": "15665415-aeeb-4fbf-be38-2aab9cff99d0",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "4d52311c-1b8e-49a7-8c9c-746cffaf931f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "ca639d72-5437-4a27-aeb2-b58c299ebe99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cc8c7c42-526a-45cc-9489-4777cf4fbbe1",
"db_currency_id": "775c1b16-ab7e-4c6d-b192-6cc10c2cb9a6",
"db_language_id": "e9c290ec-2309-4b91-9a41-905e82a7a5d2",
"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-10-04T08:36:25.5481603+00:00"
},
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "f611b439-66c9-45cd-8b47-fba5151b1e4c",
"date_reported_by_company": "2025-10-04T08:36:25.5481603+00:00",
"id2": 36,
"company_id": "c0a97bdf-a5b8-4721-89d1-a150d577062d",
"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": "50ebdc76-42d5-4f4a-9a64-0c42706363f0",
"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-10-04T08:36:25.5481603+00:00"
},
"work_instruction_details_id": "319b40e7-e328-41ac-be2a-cfbcaf3e909a",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f8648903-13f5-4f72-ba00-4cc8f52c623e",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4ab1098c-0c69-46e7-bc15-888023fb1282",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-10-04T08:36:25.5481603+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": "42e223cb-c149-461a-a983-5afabf2a2631",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-10-04T08:36:25.5481603+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.