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": "48404167-60a7-4149-8c29-89ec95894565",
"jobs_id": "146ae41e-a9f0-4f45-bd31-e7b1ded21d52",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "939094ef-b39c-44f4-a8ac-94ea1e924885",
"_parent_id": "47b0ebee-c377-4bdf-a8da-9a6f1e47ea8b",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "92cd3b7c-8d0b-441c-906b-ecfafcb8f3ab",
"project_reference_back_office": "sample string 5",
"project": {
"id": "8b23cb0e-3b39-4466-a10c-cdefa36fcfef",
"_parent_id": "262e12cc-d76c-4256-aed0-8a81794228ea",
"root_parent_id": "620e6010-cc6c-45b1-8615-f85475106fea",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "1b6924d7-6dde-4ab8-991e-649f17ffde26",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "2d577596-aba7-4713-b3d9-8f46b6d33ff3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "288c8ac1-0163-466e-8fc3-fa70078fd112",
"_parent_code": "sample string 6",
"sales_organization_id": "a8014593-2ff1-4b9a-9abe-7a68cd9b628f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"modified_dateutc": "2026-05-17T06:22:39.4789265+00:00"
},
"equipment_model_id": "713672cc-8010-4304-a44f-97e99b4e00fa",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "c9a01535-7312-4cbb-bd1f-199ac2602b08",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "19409d43-098e-4d06-ada1-a914749e75bb",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "bb5783f0-f7d2-47a8-8a12-b1a9425dbd83",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ee675d1c-8dab-4d69-9c4d-751862d4a415",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"modified_dateutc": "2026-05-17T06:22:39.4789265+00:00"
},
"equipment_family_id": "734e40b3-2f06-4429-afd0-81c84b52b42a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "2d577596-aba7-4713-b3d9-8f46b6d33ff3",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "288c8ac1-0163-466e-8fc3-fa70078fd112",
"_parent_code": "sample string 6",
"sales_organization_id": "a8014593-2ff1-4b9a-9abe-7a68cd9b628f",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"modified_dateutc": "2026-05-17T06:22:39.4789265+00:00"
},
"date_in_production_since": "2026-05-17T06:22:39.4789265+00:00",
"date_out_of_production_since": "2026-05-17T06:22:39.4789265+00:00",
"date_end_support": "2026-05-17T06:22:39.4789265+00:00",
"sales_organization_id": "41a39a8e-c2a3-4e99-838b-f4bcf3404adc",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+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-05-17T06:22:39.4945466+00:00"
},
"project_status_id": "a2833fb9-6d2a-4dec-83fb-c4682f51cee0",
"project_status_code": "sample string 10",
"project_status": {
"id": "8943136f-0be8-4522-8752-3d603eae7fa3",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "75f18db4-701d-45ae-8368-774f1e6e461e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00"
},
"company_id": "318a85b3-8074-42fa-b587-259cfb45411a",
"company_code": "sample string 12",
"db_address_id": "b9b726e7-6a18-422b-82a1-06eb979ca112",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "ef904a45-c365-4a94-85b4-eb6f1f1f8349",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "f5c34573-2457-4e63-819f-4ca4149a361c",
"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-05-17T06:22:39.4945466+00:00",
"date_create": "2026-05-17T06:22:39.4945466+00:00",
"date_update": "2026-05-17T06:22:39.4945466+00:00",
"updated_by_user_id": "9c59874e-e050-41cc-8ca6-fba8522164a6",
"customer_reference": "sample string 28",
"warranty_date_until": "2026-05-17T06:22:39.4945466+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-05-17T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2026-05-17T06:22:39.4945466+00:00",
"date_last_job": "2026-05-17T06:22:39.4945466+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2026-05-17T06:22:39.4945466+00:00",
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00",
"is_mobile_installation": true
},
"job_type_id": "b9813ae6-4e9f-4b40-b25d-07d6a7a1e6b9",
"job_type_code": "sample string 7",
"job_type": {
"id": "3a1c03d0-fd38-417c-934c-38ebe51b84bb",
"name": "sample string 2",
"sales_organization_id": "fff2deeb-88b6-4ebd-bbfe-a2a47787b9db",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00",
"code": "sample string 7"
},
"job_priority_id": "01f63cdb-b395-4aa0-8d59-6b690ea30197",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "a14845a4-75e0-4c5d-86ac-d60359827644",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "50ce8821-b373-4f1d-b7ca-36206b15490f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00"
},
"job_status_id": "ef8e8c52-d9a1-4898-a747-f583775fcdda",
"job_status_code": "sample string 11",
"db_address_id": "ef183496-bdd1-43bb-9b3e-38cdb888e13d",
"contact_id": "df8b484f-6503-427e-a257-3c03af61a9de",
"requested_by_company_id": "b9e4413e-0a18-4ecd-9a9c-0e982b96cba2",
"requested_by_contact_id": "6910b390-e422-41b0-84a0-03bbfdd898da",
"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-05-17T06:22:39.4945466+00:00",
"due_date": "2026-05-17T06:22:39.4945466+00:00",
"date_create": "2026-05-17T06:22:39.4945466+00:00",
"date_update": "2026-05-17T06:22:39.4945466+00:00",
"date_closed": "2026-05-17T06:22:39.4945466+00:00",
"suggested_user_id": "71eabd03-6066-4dbc-9f48-b8db74d679f5",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "d86162c0-e211-4ce6-b332-44ccaaa996a5",
"db_language_id": "cabfdf96-0811-44ac-bc02-87ff6ec42572",
"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-05-17T06:22:39.4945466+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "5498375d-7ce8-422a-b9d6-113c7a064778",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "b2bef449-9b45-43dd-afd5-7d052b07421a",
"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": "b583bee6-c4d0-4317-a3a9-f546dade797f",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "6ca71563-d228-4a43-8252-8c61fb44d728"
},
"suggested_date_start": "2026-05-17T06:22:39.4945466+00:00",
"skill_id": "48948d51-efe8-4755-babb-78fb95715fb6",
"skill_code": "sample string 32",
"skill": {
"id": "53fcc590-7693-4856-bd7a-0c66bee62e1c",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "5f82f4a8-4479-4d89-a1ad-f0f86feabe75",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "78e36edf-cc50-42c1-aff1-894f0dd84c91",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ace20c3e-0d8b-48c6-8aeb-ef2db7eef395",
"db_currency_id": "a58acf7f-0d8a-43e8-a063-6957f52f4ece",
"db_language_id": "6976be6f-09a5-4919-9ac4-680363101f95",
"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-05-17T06:22:39.4789265+00:00"
},
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "9a1b28c6-d8aa-4b37-8ed7-9d0ad076ac0c",
"date_reported_by_company": "2026-05-17T06:22:39.4945466+00:00",
"id2": 36,
"company_id": "707ee4cf-fd7f-47dd-8e68-c6e2aa87e80e",
"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": "0fae692e-8caa-4685-8242-a6536ea3f47f",
"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-05-17T06:22:39.4945466+00:00"
},
"work_instruction_details_id": "1c9e677b-58c6-47c4-bac0-ff0d7812ee1b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "950be1e8-326d-473b-8c20-371927343844",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "fe4997e8-35e3-4ebf-8c5a-8610cfcf1891",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2026-05-17T06:22:39.4945466+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": "54d08177-c87d-4ac8-93a6-42f6adb81cf0",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2026-05-17T06:22:39.4945466+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.