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": "aeb0bdd4-f7a4-4215-8420-3ffa4975ba0a",
"jobs_id": "dbd19c83-b2cb-46b9-a1ac-b6623a2289d0",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "f86f1fe1-ed75-4cdb-b6ab-3d469f299a88",
"_parent_id": "ef1d1a32-ec26-499a-95cb-3d6e1eb9fefc",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "4b295d2b-db03-4c4c-96f2-bc904a497fb7",
"project_reference_back_office": "sample string 5",
"project": {
"id": "9dc25ec6-91cc-4809-b786-166c432596bd",
"_parent_id": "192dcf5f-2fdc-4b9d-8249-9b2d5149506a",
"root_parent_id": "5984f6e5-9bd0-4781-ab22-2b674b51308e",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "9ae234c6-5034-4596-a9ea-4cc0df1848e0",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "4e1bf3ce-e99f-4e95-ba09-1d8a5f4ef629",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb869ab0-4a34-4470-b2e9-4136da4c8594",
"_parent_code": "sample string 6",
"sales_organization_id": "a314f2fb-4263-430b-8974-3416e96f8571",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"equipment_model_id": "39b79ab5-106d-4b81-936d-64613dc12f68",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "90ece87e-00c5-44f2-93da-8e12163a4cd1",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "687c8dae-6489-43e2-8329-72b6572998a7",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "80f48db7-90d4-4e6e-8bc8-ce88d5f3fd57",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "3cb98e9e-4cc2-4970-9ce0-01b71ed9747b",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"equipment_family_id": "a6c796bb-fdda-4e17-8de1-8ee242728e54",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "4e1bf3ce-e99f-4e95-ba09-1d8a5f4ef629",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "bb869ab0-4a34-4470-b2e9-4136da4c8594",
"_parent_code": "sample string 6",
"sales_organization_id": "a314f2fb-4263-430b-8974-3416e96f8571",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"date_in_production_since": "2025-11-14T21:56:47.5215343+00:00",
"date_out_of_production_since": "2025-11-14T21:56:47.5215343+00:00",
"date_end_support": "2025-11-14T21:56:47.5215343+00:00",
"sales_organization_id": "b0e9a175-daaa-49ba-8725-1d7ebefce954",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+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-14T21:56:47.5215343+00:00"
},
"project_status_id": "c1ea02c9-cdb6-49ea-ad2e-b76f89f4dde7",
"project_status_code": "sample string 10",
"project_status": {
"id": "d53787b7-49cc-46e0-bd42-f7ac806c225d",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "90bba90e-c52f-4b25-9f60-4cab2d974b8f",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"company_id": "141b1186-b564-4998-bf98-0c7b0d8ff029",
"company_code": "sample string 12",
"db_address_id": "360d0e76-7151-4bc2-b8b3-f74eb154d813",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "1b1b547e-49c2-4c09-9880-4c42651844c2",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "04253e4c-c9d9-431f-91e8-c9a740035dcb",
"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-14T21:56:47.5215343+00:00",
"date_create": "2025-11-14T21:56:47.5215343+00:00",
"date_update": "2025-11-14T21:56:47.5215343+00:00",
"updated_by_user_id": "7daf7ee1-ef8e-4f06-99b5-0d3c76b67575",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-11-14T21:56:47.5215343+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-14T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-11-14T21:56:47.5215343+00:00",
"date_last_job": "2025-11-14T21:56:47.5215343+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-11-14T21:56:47.5215343+00:00",
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00",
"is_mobile_installation": true
},
"job_type_id": "383a9ba0-c03d-4aab-b323-e4b6bf236a9d",
"job_type_code": "sample string 7",
"job_type": {
"id": "3bcf7e5f-21fb-4bfc-90fa-946142d67d2a",
"name": "sample string 2",
"sales_organization_id": "ec8d9747-1dc5-4f11-bab7-c5cce00be665",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00",
"code": "sample string 7"
},
"job_priority_id": "ff957ae2-ff82-4176-a9ef-e27e9e19dcc0",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "0ed10850-9957-4cce-ac98-16dd2c9f3825",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "a756b63f-221a-4c46-8dad-4eedbfd248de",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"job_status_id": "323337b1-a004-4d2b-bdeb-6e4f9586cb94",
"job_status_code": "sample string 11",
"db_address_id": "77c772d7-0693-44f3-b592-87f00bd21bbc",
"contact_id": "5a182b45-64d7-478c-b731-9ded60c8e420",
"requested_by_company_id": "00f4fe19-7818-4b3b-8d9b-3cbbc3646797",
"requested_by_contact_id": "b9365b1d-00d8-48d7-b1a6-2826b883b619",
"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-14T21:56:47.5215343+00:00",
"due_date": "2025-11-14T21:56:47.5215343+00:00",
"date_create": "2025-11-14T21:56:47.5215343+00:00",
"date_update": "2025-11-14T21:56:47.5215343+00:00",
"date_closed": "2025-11-14T21:56:47.5215343+00:00",
"suggested_user_id": "8d30caab-0138-4d35-8895-69b0f3fd4fd9",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "01fb5f44-8044-42e8-8bab-d730126ac537",
"db_language_id": "d8003a57-4342-4468-9ff4-83cf7d6e261e",
"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-14T21:56:47.5215343+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "cef239dd-676f-45ef-b645-9be954fad7e1",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "8de66651-0f21-4f08-9eac-92e413aac485",
"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": "32d15319-d1dc-4fca-8331-8ade09204800",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "d8dc1ffd-566a-4440-bf4a-2f5bf777ac5a"
},
"suggested_date_start": "2025-11-14T21:56:47.5215343+00:00",
"skill_id": "d2fe0b1c-cb5b-488f-8f63-361e447fe0f6",
"skill_code": "sample string 32",
"skill": {
"id": "1f1d0f7b-291d-402c-b92d-352c16f3540d",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "3f7b3c5f-4fe7-4e9a-8a08-e49463d57d2e",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "b54e3a31-350c-4c45-be07-9a39debf3445",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "ac1d92cc-5df0-4c78-94be-9686641fa54c",
"db_currency_id": "7e07a8c0-13d0-4273-91b7-ed226d146086",
"db_language_id": "d6e1ccfc-3949-4501-9813-de60ce6129ab",
"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-14T21:56:47.5215343+00:00"
},
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6e13c0af-d7ef-4a8a-b6be-2f5a250ea62f",
"date_reported_by_company": "2025-11-14T21:56:47.5215343+00:00",
"id2": 36,
"company_id": "0632b75a-4878-4b77-a2c6-eaf26865910a",
"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": "9ce97c54-5188-47d4-9680-ed71cd59046e",
"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-14T21:56:47.5215343+00:00"
},
"work_instruction_details_id": "25373205-b33c-474c-b9d3-69abd35bdae4",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "946a3e4e-1a8a-4e39-bfdd-2517188f8600",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "08f6d6a0-4911-45bb-b166-7f915afce178",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-11-14T21:56:47.5215343+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": "271dee62-316c-437c-a27d-60c45d13475c",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-11-14T21:56:47.5215343+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.