Creates a new job work instruction list.

Request Information

URI Parameters :

None.

Body Parameters :

job_work_instruction_list
NameDescriptionTypeAdditional 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": "bc3d48ab-e1c2-408b-9101-c95a303eb262",
  "jobs_id": "3f5a0c98-3120-42fc-a350-88fed16219df",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "7c2a55d5-3fc0-462d-94a2-752b60e69c69",
    "_parent_id": "dfa9ef46-0f94-47ac-ada3-2c0d257b4189",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "c405f62f-8428-4aaa-98f3-c8ea30b19acd",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "e67f9c38-bb34-411b-a14e-cf44a57ccbb3",
      "_parent_id": "6b4fa9b8-3dcb-4c3e-ab9f-e2490e7abf32",
      "root_parent_id": "b75eae09-d8aa-40f5-91be-4d2a427cf7c9",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "5bd4ed77-26b7-4e7a-ac41-ab37e0589799",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "765609a5-0776-4e48-8e50-9d7b9c0c8f73",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "baddc79d-fd1f-4463-9644-457279baea17",
        "_parent_code": "sample string 6",
        "sales_organization_id": "ba655f47-81fd-4f9f-8474-76e485be8594",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
          "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
          "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
          "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-11-17T15:42:25.0886782+00:00"
        },
        "modified_dateutc": "2026-11-17T15:42:25.1014716+00:00"
      },
      "equipment_model_id": "961bf8dc-0c1f-4c38-9b64-498054c0d5f2",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "892d7c92-3599-4ace-ba4e-a8f346e8478e",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "7622a67d-a858-49b1-9770-7b06dfc70a7f",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "67813064-d154-42ab-bc4b-3d1dd8899e1c",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "3e3aa5f6-c030-4a40-b9c8-0c4c34c6c2e0",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
            "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
            "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
            "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-11-17T15:42:25.0886782+00:00"
          },
          "modified_dateutc": "2026-11-17T15:42:25.1178288+00:00"
        },
        "equipment_family_id": "827e949a-5a89-4c89-ae36-478e5b667fa7",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "765609a5-0776-4e48-8e50-9d7b9c0c8f73",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "baddc79d-fd1f-4463-9644-457279baea17",
          "_parent_code": "sample string 6",
          "sales_organization_id": "ba655f47-81fd-4f9f-8474-76e485be8594",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
            "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
            "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
            "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-11-17T15:42:25.0886782+00:00"
          },
          "modified_dateutc": "2026-11-17T15:42:25.1014716+00:00"
        },
        "date_in_production_since": "2026-11-17T15:42:25.1178288+00:00",
        "date_out_of_production_since": "2026-11-17T15:42:25.1178288+00:00",
        "date_end_support": "2026-11-17T15:42:25.1178288+00:00",
        "sales_organization_id": "bbd8d609-b105-4165-ba6d-f42750b33e48",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
          "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
          "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
          "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-11-17T15:42:25.0886782+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-11-17T15:42:25.1178288+00:00"
      },
      "project_status_id": "c110e91c-15b5-495c-8f12-5b2a6737a15e",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "0c9c8f6f-1750-4404-b6c9-2d7e00a45e2b",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "71e98d49-c6b5-4942-a68c-a3cf4f5f9653",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
          "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
          "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
          "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-11-17T15:42:25.0886782+00:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2026-11-17T15:42:25.1178288+00:00"
      },
      "company_id": "89b7363c-7ead-4fab-901e-082b6c10c3ad",
      "company_code": "sample string 12",
      "db_address_id": "598c9c19-28ad-49e7-8250-c78e55464d67",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "8af238c1-4528-41a9-a4ce-7c1c300d5e6f",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "4a9fd246-517f-4dcb-b485-da62e8f87206",
      "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-11-17T15:42:25.1178288+00:00",
      "date_create": "2026-11-17T15:42:25.1178288+00:00",
      "date_update": "2026-11-17T15:42:25.1178288+00:00",
      "updated_by_user_id": "c83fa703-87b5-468f-aa40-9dfb866b0a88",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2026-11-17T15:42:25.1178288+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-11-17T00:00:00+00:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2026-11-17T15:42:25.1178288+00:00",
      "date_last_job": "2026-11-17T15:42:25.1178288+00:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2026-11-17T15:42:25.1178288+00:00",
      "modified_dateutc": "2026-11-17T15:42:25.1178288+00:00",
      "is_mobile_installation": true
    },
    "job_type_id": "c493469c-e78d-4104-ad80-1a06833d05f3",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "6dee6e6f-4f59-4645-9e28-0fe21ddd8a35",
      "name": "sample string 2",
      "sales_organization_id": "b55e2551-5559-4169-b9d1-36d6720eaf20",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2026-11-17T15:42:25.1369092+00:00",
      "code": "sample string 7"
    },
    "job_priority_id": "77885b7e-3048-4c0f-978c-9330cc5193c9",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "e1d41b4e-8c45-4a0f-aded-09a28ebb4d97",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "b0c21b84-c3f3-4d95-8652-5f2ecaaa20cb",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
        "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
        "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
        "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-11-17T15:42:25.0886782+00:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2026-11-17T15:42:25.1369092+00:00"
    },
    "job_status_id": "bfd70446-143d-44db-a980-d7773e90b896",
    "job_status_code": "sample string 11",
    "db_address_id": "55683c50-8f47-47a0-aef4-4958defeaa60",
    "contact_id": "fefddc83-5948-48df-81d3-c0718a1272b3",
    "requested_by_company_id": "c37af2aa-d26f-4e72-b40c-0448e07cba19",
    "requested_by_contact_id": "1845565a-f497-49cc-ad8d-d0f5c3e6ce90",
    "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-11-17T15:42:25.1369092+00:00",
    "due_date": "2026-11-17T15:42:25.1369092+00:00",
    "date_create": "2026-11-17T15:42:25.1369092+00:00",
    "date_update": "2026-11-17T15:42:25.1369092+00:00",
    "date_closed": "2026-11-17T15:42:25.1369092+00:00",
    "suggested_user_id": "46ab25cf-3b34-4241-976b-b992b1f44243",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "1efa3acd-0392-446b-923c-72ac4d53d924",
      "db_language_id": "5547852f-f86d-43b8-acd3-8d2b85efae4d",
      "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-11-17T15:42:25.1369092+00:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "9615aaf8-f781-47db-b338-04dd9813d450",
      "sales_organization": {
        "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
        "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
        "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
        "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-11-17T15:42:25.0886782+00:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "618fa4ad-7d82-4a4e-9bbd-8dbc4a35a51b",
      "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": "8b71cf5a-4c5d-4fb8-8632-9635be229c86",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2026-11-17T15:42:25.1369092+00:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "9a27f6bb-2133-4d4e-ac7e-d5dc2d660d59"
    },
    "suggested_date_start": "2026-11-17T15:42:25.1369092+00:00",
    "skill_id": "b99741e5-ca1d-40e5-a91b-8adda0b153f1",
    "skill_code": "sample string 32",
    "skill": {
      "id": "6cd2d6b8-89fd-4da8-86aa-dd572aebd8ae",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "b1b309f9-6b7e-478f-a516-e93b6584750a",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "9c5f5227-a798-4450-bed2-e49f763c34d9",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "f397d471-04c7-4040-bebf-42fd9dead414",
        "db_currency_id": "f42281e8-ef9b-4475-bfa0-dc33fbfad5b3",
        "db_language_id": "4d0c9d60-1c59-4a30-835a-ddcb4f34ada9",
        "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-11-17T15:42:25.0886782+00:00"
      },
      "modified_dateutc": "2026-11-17T15:42:25.1483518+00:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "2a86dc11-8f68-4f3c-8897-48d882f2ed88",
    "date_reported_by_company": "2026-11-17T15:42:25.1483518+00:00",
    "id2": 36,
    "company_id": "a3693db2-13ca-4a16-ac72-32d7a360d3f3",
    "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": "012f5d20-47ec-4c86-acf8-ed17a00e7d90",
    "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-11-17T15:42:25.1483518+00:00"
  },
  "work_instruction_details_id": "4299936d-1d58-4c81-9ad7-0aefcf0a26e6",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "2d129b24-b4ad-4a73-9664-1222478e53b0",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "b7bed89d-d577-4cf9-9b20-8f26e4301146",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2026-11-17T15:42:25.1483518+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": "43a09b65-fedb-44fc-9fd7-db3c771012df",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2026-11-17T15:42:25.1483518+00:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.