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": "a589a55a-984d-4718-a7ec-458008ea2e3e",
"jobs_id": "0a8cc302-1dcd-4ce3-8e0c-f3d4357d420a",
"jobs_reference_back_office": "sample string 3",
"jobs": {
"id": "80979b57-7019-43bf-94f6-c9494679f517",
"_parent_id": "0ce3ece4-b589-4022-b171-88c43eca6b0d",
"_parent_jobs_reference_back_office": "sample string 3",
"project_id": "e1ad73e6-2917-417f-be26-4cea58feb495",
"project_reference_back_office": "sample string 5",
"project": {
"id": "19d0627f-093b-4dca-a191-b8afff157d40",
"_parent_id": "701ecbf1-4d58-468a-9dd0-2c224b461114",
"root_parent_id": "bd7778ab-2706-4411-9889-610dd5e19c61",
"_parent_reference_back_office": "sample string 4",
"equipment_family_id": "8f3b139d-d982-4ed6-8c62-4e7c6273c6a3",
"equipment_family_code": "sample string 6",
"equipment_family": {
"id": "b7d8ce8c-d8bd-4f8e-9763-4c376aca8106",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "80f57768-270d-4e47-8d04-cc11ece76be1",
"_parent_code": "sample string 6",
"sales_organization_id": "15b61530-416a-4c05-b16e-b6b1a7c12a0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"modified_dateutc": "2025-05-09T06:25:58.0221828+00:00"
},
"equipment_model_id": "7b29c2b3-bcfe-4cc8-9589-26d86f3a2455",
"equipment_model_code": "sample string 8",
"equipment_model": {
"id": "3e176ecb-9b95-47ee-a1e1-ceb5234882c0",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"equipment_brand_id": "65b594be-30ee-4a38-a7fb-07520d65fe7b",
"equipment_brand_code": "sample string 6",
"equipment_brand": {
"id": "6c55656e-b7dd-4f07-bc4d-692f75e26b83",
"name": "sample string 2",
"code": "sample string 3",
"sales_organization_id": "2cd82309-6df2-48e9-a3bb-1ef0ce205b0a",
"sales_organization_code": "sample string 5",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"modified_dateutc": "2025-05-09T06:25:58.0221828+00:00"
},
"equipment_family_id": "da006dcf-35c6-4d15-8933-e491f0fe7e42",
"equipment_family_code": "sample string 8",
"equipment_family": {
"id": "b7d8ce8c-d8bd-4f8e-9763-4c376aca8106",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"_parent_id": "80f57768-270d-4e47-8d04-cc11ece76be1",
"_parent_code": "sample string 6",
"sales_organization_id": "15b61530-416a-4c05-b16e-b6b1a7c12a0c",
"sales_organization_code": "sample string 8",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"modified_dateutc": "2025-05-09T06:25:58.0221828+00:00"
},
"date_in_production_since": "2025-05-09T06:25:58.0221828+00:00",
"date_out_of_production_since": "2025-05-09T06:25:58.0221828+00:00",
"date_end_support": "2025-05-09T06:25:58.0221828+00:00",
"sales_organization_id": "8e00662b-46d7-480a-90af-69c9dca3a7b2",
"sales_organization_code": "sample string 13",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+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-05-09T06:25:58.0378129+00:00"
},
"project_status_id": "7a3461c7-3f79-4623-ae0b-bb38161c3793",
"project_status_code": "sample string 10",
"project_status": {
"id": "9bc32c7a-6193-469c-9a9b-43431df98c81",
"name": "sample string 2",
"is_default": true,
"is_closed": true,
"sales_organization_id": "e72c7d37-e1b5-44f8-84eb-995c90f3c987",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00"
},
"company_id": "718b6f7d-25f1-47bb-89cc-17bea966b66b",
"company_code": "sample string 12",
"db_address_id": "c0b8a00b-4c66-45b5-991c-a1a1b1b4826c",
"db_address_code": "sample string 14",
"location": "sample string 15",
"contact_id": "deffbfab-02f6-4b03-9af1-d075b7ff4b43",
"contact_reference_back_office": "sample string 17",
"owner_user_id": "89b21fc8-6544-4a65-8f7e-c68c8046057a",
"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-05-09T06:25:58.0378129+00:00",
"date_create": "2025-05-09T06:25:58.0378129+00:00",
"date_update": "2025-05-09T06:25:58.0378129+00:00",
"updated_by_user_id": "3b399b37-a15f-49c3-b72d-9fe94a335c0b",
"customer_reference": "sample string 28",
"warranty_date_until": "2025-05-09T06:25:58.0378129+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-05-09T00:00:00+00:00",
"shutdown_consequence": "sample string 35",
"id2": 36,
"nb_open_jobs": 37,
"date_next_job": "2025-05-09T06:25:58.0378129+00:00",
"date_last_job": "2025-05-09T06:25:58.0378129+00:00",
"nb_jobs_planned": 40,
"nb_jobs_tobeplanned": 41,
"nb_jobs_waitingfurtheraction": 42,
"back_office_timestamp": "2025-05-09T06:25:58.0378129+00:00",
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00",
"is_mobile_installation": true
},
"job_type_id": "69f3b30b-3e1f-4eaa-b899-59c63f3f36ef",
"job_type_code": "sample string 7",
"job_type": {
"id": "beda702a-0c95-4e43-b87e-b2df1db9cea7",
"name": "sample string 2",
"sales_organization_id": "6f2ac9f3-fe17-4e04-82ae-62626c3cbf5d",
"description": "sample string 4",
"is_default": true,
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00",
"code": "sample string 7"
},
"job_priority_id": "efccb87c-06cb-4ff8-93ca-028c1999128f",
"job_priority_code": "sample string 9",
"job_priority": {
"id": "273cf314-4fda-416b-8aad-df6408e74b33",
"name": "sample string 2",
"is_default": true,
"sequence": 4,
"sales_organization_id": "7365b7ee-bdc1-4bd6-be0b-da06f9ce5819",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"code": "sample string 7",
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00"
},
"job_status_id": "e967365b-7f5d-45f3-9394-1ad3f6df7f30",
"job_status_code": "sample string 11",
"db_address_id": "b0e65fcb-338a-48ad-85ff-eb69e1b5e388",
"contact_id": "02dadede-c8fb-446c-b47f-cf17341dc014",
"requested_by_company_id": "3b2a23ea-7d51-454a-8c8f-b8a4a5fc44c1",
"requested_by_contact_id": "7c02a7e1-2129-4999-a03b-1151041c82a7",
"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-05-09T06:25:58.0378129+00:00",
"due_date": "2025-05-09T06:25:58.0378129+00:00",
"date_create": "2025-05-09T06:25:58.0378129+00:00",
"date_update": "2025-05-09T06:25:58.0378129+00:00",
"date_closed": "2025-05-09T06:25:58.0378129+00:00",
"suggested_user_id": "29746ea8-d899-43fe-a4b8-636e3dd287ed",
"suggested_user_code": "sample string 29",
"suggested_user": {
"id": "df69ef24-a6c1-4184-a1e1-56e924c3a047",
"db_language_id": "ca104680-6721-41cd-bfcb-67f382e0d859",
"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-05-09T06:25:58.0378129+00:00",
"skype": "sample string 16",
"notes": "sample string 17",
"sales_organization_id": "451a69ce-7f48-4d3f-a5b1-fb0dc5970f95",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"sales_organization_code": "sample string 19",
"is_team_leader": true,
"team_leader_user_id": "ee4d2f54-8fc9-4529-b3dd-24cc3ec7bf90",
"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": "17eb93d3-01f5-463c-a63b-bc036c5558a9",
"private_db_country_code": "sample string 35",
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00",
"allow_hero_app": true,
"allow_sales_app": true,
"allow_service_app": true,
"user_group_id": "aae6eacd-1c79-460c-94d1-465f3b373478"
},
"suggested_date_start": "2025-05-09T06:25:58.0378129+00:00",
"skill_id": "24dc56be-f04a-440d-8255-2578fbf927af",
"skill_code": "sample string 32",
"skill": {
"id": "27eab82c-b428-4b2c-9082-1fba99ea2903",
"name": "sample string 2",
"description": "sample string 3",
"code": "sample string 4",
"sales_organization_id": "8bda6f7f-3c0b-42e9-9fd8-d7e9b98630be",
"sales_organization_code": "sample string 6",
"sales_organization": {
"id": "4a006d6b-9066-4b83-ae65-c0df2b88ab19",
"code": "sample string 2",
"name": "sample string 3",
"description": "sample string 4",
"db_country_id": "40444ccb-c3c0-4428-b40d-160c78266b16",
"db_currency_id": "a140b229-8a7e-4781-b2c8-9945555894c8",
"db_language_id": "fabf9863-cb08-410d-903f-95135d65cfa6",
"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-05-09T06:25:58.0221828+00:00"
},
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00"
},
"customer_reference": "sample string 33",
"approval_responsible_user_id": "6d03f881-40e0-4c3d-a220-d6a44fb5c004",
"date_reported_by_company": "2025-05-09T06:25:58.0378129+00:00",
"id2": 36,
"company_id": "37326a25-d536-45a2-833b-b21a4a389426",
"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": "47e21e2c-31f5-4c09-a9e6-6b4bf14929cd",
"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-05-09T06:25:58.0378129+00:00"
},
"work_instruction_details_id": "cdeab21c-c1fb-4d91-9af7-f9f8dfadc860",
"work_instruction_details_reference_back_office": "sample string 5",
"user_id": "f73b7b60-c025-447f-b8a9-b779ed395f8d",
"work_instruction_action_type": "sample string 7",
"work_instruction_id": "4395e790-a616-4d63-babb-b9a1bae25a8e",
"work_instruction_reference_back_office": "sample string 9",
"name": "sample string 10",
"status": "sample string 11",
"date_done": "2025-05-09T06:25:58.0378129+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": "2def615a-0d98-4350-a833-2f43b11edeef",
"db_report_type_name": "sample string 18",
"modified_dateutc": "2025-05-09T06:25:58.0378129+00:00"
}
Response Information
Resource Description :
IHttpActionResultNone.
Response Formats
application/json, text/json
Sample:
Sample not available.