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": "cab3bf98-351c-4c06-91de-cb356487dc1a",
"jobs_id": "0d7102c8-894f-4d2c-bcd9-6e6c55f9d34e",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "56e1dde6-62f0-4dc7-a814-5706870bee4a",
"_parent_id": "7d6894b3-19ed-467c-b441-b694891422c7",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "15266150-f287-4939-bc7d-1cca428bcd32",
"project_reference_back_office": "sample string 5",
"project": {
"id": "860566bc-fd3f-43a8-9cfb-859e8f8b4858",
"_parent_id": "60d7768e-365b-4d56-a286-0491ee31d220",
"root_parent_id": "f3a54c2e-17a5-4c4c-b9d6-06de68ae295a",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "b4f923d7-266e-42ae-8ba0-87253ff31ea3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "1920d541-e088-4c1e-b709-36e8ee44d860",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3dd5686-6885-4163-8419-c664b972bc13",
"_parent_code": "sample string 6",
"sales_organization_id": "9af72533-5734-41f1-a725-4f32492299c1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00"
},
"equipment_model_id": "5668ccf1-4019-4a50-9b30-fd57a03da82d",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "72c92355-1782-4df7-bacb-b0fc9f2e93d0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "f439cc4a-7b5b-4c52-8b46-ea290d29782d",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "da34dac5-c1b3-4eb3-a98e-cc82ba8ad321",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "ff2770ff-065f-49e6-b706-4f6ef0f8b07a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00"
},
"equipment_family_id": "ef2812f0-6533-4d7c-aca8-dcfc4a77a99a",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "1920d541-e088-4c1e-b709-36e8ee44d860",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "f3dd5686-6885-4163-8419-c664b972bc13",
"_parent_code": "sample string 6",
"sales_organization_id": "9af72533-5734-41f1-a725-4f32492299c1",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00"
},
"date_in_production_since": "2025-11-03T06:20:32.9694982+00:00",
"date_out_of_production_since": "2025-11-03T06:20:32.9694982+00:00",
"date_end_support": "2025-11-03T06:20:32.9694982+00:00",
"sales_organization_id": "d2064d79-8f99-493c-8b13-c584047792c3",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+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-03T06:20:32.9694982+00:00"
},
"project_status_id": "1fcaeadf-7bfa-4f86-887f-e14dd1331f25",
"project_status_code": "sample string 10",
"project_status": {
"id": "ea255609-1e67-457d-83e1-97917ed0e75f",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "3dbdab47-e93a-4ef8-9309-410a1dd6b89a",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00"
},
"company_id": "bf2a99a4-588a-4617-8767-3513bb9e65cc",
"company_code": "sample string 12",
"db_address_id": "3a121db6-80cb-4954-99e6-f11873f00bd4",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1815531b-a13c-4d12-94bc-0f37ec7ff827",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "759755c7-ff11-4b9e-85d4-4b6af38f3c44",
"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-03T06:20:32.9694982+00:00",
"date_create": "2025-11-03T06:20:32.9694982+00:00",
"date_update": "2025-11-03T06:20:32.9694982+00:00",
"updated_by_user_id": "effb5b76-b5b5-4179-a8ec-5a44f80fdeae",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-03T06:20:32.9694982+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-03T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-03T06:20:32.9694982+00:00",
"date_last_job": "2025-11-03T06:20:32.9694982+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-03T06:20:32.9694982+00:00",
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00",
"is_mobile_installation": true
},
"job_type_id": "3797fe02-1519-49f5-9c7e-6f93138be339",
"job_type_code": "sample string 7",
"job_type": {
"id": "496faf70-9bf5-4f56-a296-e48dcf9268b0",
"name": "sample string 2",
"sales_organization_id": "55972a89-0788-42cb-a792-c1e079dc1735",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00",
"code": "sample string 7"
},
"job_priority_id": "f80c70e0-8009-4e55-a5d2-6204efbef316",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "22ff0313-cc7b-4151-81dc-3f4094fef727",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "b05cef4a-712f-4b9b-adca-bceee92917c8",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-03T06:20:32.9694982+00:00"
},
"job_status_id": "c43fa7af-2de5-401c-a533-1b70db1fb4e9",
"job_status_code": "sample string 11",
"db_address_id": "4a304256-49bd-4d7f-ae01-2d057c576e8e",
"contact_id": "1b220dc6-2c60-4d3c-a5aa-ca77aa367be4",
"requested_by_company_id": "b0c7b1df-d5e9-487f-a645-42759ff27364",
"requested_by_contact_id": "62ce9d74-793f-43f8-adb5-068d395188a8",
"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-03T06:20:32.9694982+00:00",
"due_date": "2025-11-03T06:20:32.9694982+00:00",
"date_create": "2025-11-03T06:20:32.9694982+00:00",
"date_update": "2025-11-03T06:20:32.9694982+00:00",
"date_closed": "2025-11-03T06:20:32.9694982+00:00",
"suggested_user_id": "8a3e8400-5bc5-45ae-ae3e-5bcbf1c3e8b8",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "885742e8-ba44-4b2e-ab6c-6478812253d0",
"db_language_id": "9a6d8176-673e-45ef-9fae-aeb691de137a",
"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-03T06:20:32.9851391+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "dcfbcfc2-8da0-4250-a0b5-a0baa452a494",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "fcd3a3c1-9c97-42fe-8c04-c4dd2a99c8f4",
"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": "0fcf4d24-d170-42f3-bf71-0d110fecd729",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-03T06:20:32.9851391+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "ca92a745-c719-4287-a4e7-e6cc0c15eda3"
},
"suggested_date_start": "2025-11-03T06:20:32.9851391+00:00",
"skill_id": "2c73c51a-4716-4ddf-863b-b053e392e8d2",
"skill_code": "sample string 32",
"skill": {
"id": "7c6c3336-cd70-4b35-9254-186da50c2927",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "cd6d6027-da8c-4b4f-8c8b-d1cd0715e98e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "46f37256-7eca-4fd4-8693-98cfb11a4e99",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "cf7d966d-bc4d-4491-b305-eb02fc32cae8",
"db_currency_id": "606a8e0b-9a98-44b8-be56-1e273c09a79f",
"db_language_id": "95548515-7141-419e-a3a9-6c5f3478fe43",
"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-03T06:20:32.9694982+00:00"
},
"modified_dateutc": "2025-11-03T06:20:32.9851391+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "125af636-2e35-4e9c-b9ef-1bf2da0b255d",
"date_reported_by_company": "2025-11-03T06:20:32.9851391+00:00",
"id2": 36,
"company_id": "11e7ee6b-6996-43e1-a104-165c770a21d1",
"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": "84b5f808-3215-469b-8cab-9b721c8b6603",
"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-03T06:20:32.9851391+00:00"
},
"work_instruction_details_id": "b29b74a4-4d19-44da-a189-465d7725176b",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "4a59674b-44e3-482c-865b-f2d43c4178b0",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "d27479ef-ed4b-4c68-859c-1915314d822b",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-03T06:20:32.9851391+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": "13dc8b4e-bf40-405a-8794-d3643b2bdd49",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-03T06:20:32.9851391+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.