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: 50

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: 50

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": "fcad4aa9-a43c-4e6e-ba88-a03f3cfa3dcb",
  "jobs_id": "cf25c4fc-ada2-428d-b1a2-aee8bf80e319",
  "jobs_reference_back_office": "sample string 3",
  "jobs": {
    "id": "2e81a3d9-3004-432c-86db-46ef873879ba",
    "_parent_id": "830a1ac5-f264-4f0f-8e27-c492480bef2f",
    "_parent_jobs_reference_back_office": "sample string 3",
    "project_id": "935b2d11-1626-48fb-a879-2b0fdeac013e",
    "project_reference_back_office": "sample string 5",
    "project": {
      "id": "a7feff24-fa41-41f2-a38b-1205ed33da80",
      "_parent_id": "b216f70d-b1e0-43f0-a28d-928c6123d19a",
      "root_parent_id": "2cb7eb15-37ec-4ee9-a70e-5b2a3bdb4afc",
      "_parent_reference_back_office": "sample string 4",
      "equipment_family_id": "bbdf8b25-fc0a-491e-adf1-dc092dec140c",
      "equipment_family_code": "sample string 6",
      "equipment_family": {
        "id": "f0ef0f7d-53b8-46a3-9c40-e7581126829d",
        "name": "sample string 2",
        "description": "sample string 3",
        "code": "sample string 4",
        "_parent_id": "01673283-4513-4e16-8355-445372d687ba",
        "_parent_code": "sample string 6",
        "sales_organization_id": "70301a8a-f019-493e-9e50-822957166e63",
        "sales_organization_code": "sample string 8",
        "sales_organization": {
          "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
          "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
          "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
          "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": "2022-08-17T03:09:48.4123925+02:00"
        },
        "modified_dateutc": "2022-08-17T03:09:48.4123925+02:00"
      },
      "equipment_model_id": "43ed2817-dad1-4f8f-ba15-644a10b81a41",
      "equipment_model_code": "sample string 8",
      "equipment_model": {
        "id": "ea54b3f6-2198-4e7b-a9b7-01cccbeaf636",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "equipment_brand_id": "706e5288-f90b-48a4-993b-2f0f32a7c2b3",
        "equipment_brand_code": "sample string 6",
        "equipment_brand": {
          "id": "c3aa4617-e617-4b16-a273-97a2bef40093",
          "name": "sample string 2",
          "code": "sample string 3",
          "sales_organization_id": "d9a39374-8089-4456-80fa-20661d58707a",
          "sales_organization_code": "sample string 5",
          "sales_organization": {
            "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
            "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
            "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
            "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": "2022-08-17T03:09:48.4123925+02:00"
          },
          "modified_dateutc": "2022-08-17T03:09:48.4123925+02:00"
        },
        "equipment_family_id": "72dfd755-5325-4cce-ab09-64340834b67c",
        "equipment_family_code": "sample string 8",
        "equipment_family": {
          "id": "f0ef0f7d-53b8-46a3-9c40-e7581126829d",
          "name": "sample string 2",
          "description": "sample string 3",
          "code": "sample string 4",
          "_parent_id": "01673283-4513-4e16-8355-445372d687ba",
          "_parent_code": "sample string 6",
          "sales_organization_id": "70301a8a-f019-493e-9e50-822957166e63",
          "sales_organization_code": "sample string 8",
          "sales_organization": {
            "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
            "code": "sample string 2",
            "name": "sample string 3",
            "description": "sample string 4",
            "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
            "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
            "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
            "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": "2022-08-17T03:09:48.4123925+02:00"
          },
          "modified_dateutc": "2022-08-17T03:09:48.4123925+02:00"
        },
        "date_in_production_since": "2022-08-17T03:09:48.4123925+02:00",
        "date_out_of_production_since": "2022-08-17T03:09:48.4123925+02:00",
        "date_end_support": "2022-08-17T03:09:48.4293446+02:00",
        "sales_organization_id": "08d13a7c-5ce8-4c83-8146-053cbcc101c0",
        "sales_organization_code": "sample string 13",
        "sales_organization": {
          "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
          "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
          "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
          "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": "2022-08-17T03:09:48.4123925+02: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": "2022-08-17T03:09:48.4293446+02:00"
      },
      "project_status_id": "74ab3728-fb29-4a3b-b671-12aee07c124f",
      "project_status_code": "sample string 10",
      "project_status": {
        "id": "1fedce94-0f14-4590-8d1c-af11a0ff1dd2",
        "name": "sample string 2",
        "is_default": true,
        "is_closed": true,
        "sales_organization_id": "f5ceb75d-1841-4da9-83b7-098bacd4159d",
        "sales_organization_code": "sample string 6",
        "sales_organization": {
          "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
          "code": "sample string 2",
          "name": "sample string 3",
          "description": "sample string 4",
          "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
          "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
          "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
          "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": "2022-08-17T03:09:48.4123925+02:00"
        },
        "code": "sample string 7",
        "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00"
      },
      "company_id": "cd0407f9-17b5-4fcf-a440-d1cd2d72a690",
      "company_code": "sample string 12",
      "db_address_id": "4c9c3fba-7c7d-4f81-8c90-b5f89fd72967",
      "db_address_code": "sample string 14",
      "location": "sample string 15",
      "contact_id": "6d5af113-15e1-4ca7-925f-1b07669e37e9",
      "contact_reference_back_office": "sample string 17",
      "owner_user_id": "69a15d0f-b6ef-4dd7-87eb-321db4427f43",
      "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": "2022-08-17T03:09:48.4293446+02:00",
      "date_create": "2022-08-17T03:09:48.4293446+02:00",
      "date_update": "2022-08-17T03:09:48.4293446+02:00",
      "updated_by_user_id": "f15ae5c8-3c4e-4967-b11c-5a8441905f6f",
      "customer_reference": "sample string 28",
      "warranty_date_until": "2022-08-17T03:09:48.4293446+02: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": "2022-08-17T00:00:00+02:00",
      "shutdown_consequence": "sample string 35",
      "id2": 36,
      "nb_open_jobs": 37,
      "date_next_job": "2022-08-17T03:09:48.4293446+02:00",
      "date_last_job": "2022-08-17T03:09:48.4293446+02:00",
      "nb_jobs_planned": 40,
      "nb_jobs_tobeplanned": 41,
      "nb_jobs_waitingfurtheraction": 42,
      "back_office_timestamp": "2022-08-17T03:09:48.4293446+02:00",
      "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00",
      "is_mobile_installation": true
    },
    "job_type_id": "f26cc1a4-ec20-41ae-887e-a3bb8a6d65d5",
    "job_type_code": "sample string 7",
    "job_type": {
      "id": "1035488f-a1d4-4f03-a161-fb432c167cab",
      "name": "sample string 2",
      "sales_organization_id": "ad8817d3-575c-4a08-bbab-373ddb08be0e",
      "description": "sample string 4",
      "is_default": true,
      "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00",
      "code": "sample string 7"
    },
    "job_priority_id": "4b7e9a23-3c27-4916-8f06-5df8ebf8df84",
    "job_priority_code": "sample string 9",
    "job_priority": {
      "id": "c265fc3b-2d66-4b85-b2ba-53b223b04705",
      "name": "sample string 2",
      "is_default": true,
      "sequence": 4,
      "sales_organization_id": "4549d822-8367-458f-bb7f-24f20a5c9b23",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
        "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
        "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
        "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": "2022-08-17T03:09:48.4123925+02:00"
      },
      "code": "sample string 7",
      "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00"
    },
    "job_status_id": "d6fbed31-7fab-4046-a2e6-f16dec9770fe",
    "job_status_code": "sample string 11",
    "db_address_id": "765a7fa6-d422-4c57-89e2-f9aa87b3021f",
    "contact_id": "37021444-51c8-4fce-8649-3f778d14de60",
    "requested_by_company_id": "720e5299-8167-459b-a647-218abd04f545",
    "requested_by_contact_id": "b793396e-8482-4e7f-9853-e0e81801544e",
    "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": "2022-08-17T03:09:48.4293446+02:00",
    "due_date": "2022-08-17T03:09:48.4293446+02:00",
    "date_create": "2022-08-17T03:09:48.4293446+02:00",
    "date_update": "2022-08-17T03:09:48.4293446+02:00",
    "date_closed": "2022-08-17T03:09:48.4293446+02:00",
    "suggested_user_id": "40f204e5-2170-4543-9212-afe8cfce723f",
    "suggested_user_code": "sample string 29",
    "suggested_user": {
      "id": "7449a91c-1a79-4ac8-ae03-a6ed00a87b2d",
      "db_language_id": "642536b5-888c-4d15-9a87-25d75327c0a3",
      "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": "2022-08-17T03:09:48.4293446+02:00",
      "skype": "sample string 16",
      "notes": "sample string 17",
      "sales_organization_id": "c52d5056-c600-40f7-a912-8c105c51b02f",
      "sales_organization": {
        "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
        "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
        "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
        "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": "2022-08-17T03:09:48.4123925+02:00"
      },
      "sales_organization_code": "sample string 19",
      "is_team_leader": true,
      "team_leader_user_id": "c5cba163-a36c-4fac-a6f8-8a5f5576e07b",
      "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": "7e825a2b-7274-49f3-b993-589952d42dc0",
      "private_db_country_code": "sample string 35",
      "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00",
      "allow_hero_app": true,
      "allow_sales_app": true,
      "allow_service_app": true,
      "user_group_id": "640faf4d-7a6f-4a9d-b10e-7c0f47253a2a"
    },
    "suggested_date_start": "2022-08-17T03:09:48.4293446+02:00",
    "skill_id": "3b28b754-4dea-4d74-9f4e-cbffdc6abeb9",
    "skill_code": "sample string 32",
    "skill": {
      "id": "225e59fd-6bf3-4351-849d-cfea53098d41",
      "name": "sample string 2",
      "description": "sample string 3",
      "code": "sample string 4",
      "sales_organization_id": "d4856ade-22ca-424e-ba1a-c811fe020f8d",
      "sales_organization_code": "sample string 6",
      "sales_organization": {
        "id": "c03d2849-3bff-49f1-b96b-1ca4be380f8c",
        "code": "sample string 2",
        "name": "sample string 3",
        "description": "sample string 4",
        "db_country_id": "d5289876-c294-401c-86c7-75645c7b1e12",
        "db_currency_id": "3204247c-d3cc-4491-98b8-166a3a89c63f",
        "db_language_id": "d0daaeb7-4ed8-464f-bde3-f2bfc12df0b4",
        "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": "2022-08-17T03:09:48.4123925+02:00"
      },
      "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00"
    },
    "customer_reference": "sample string 33",
    "approval_responsible_user_id": "ef71c5cb-7465-40fe-acd2-bb88ba7b5cb9",
    "date_reported_by_company": "2022-08-17T03:09:48.4293446+02:00",
    "id2": 36,
    "company_id": "48bc99f3-bb93-42b6-bc2f-89bb3e5e8d1a",
    "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": "e0bdf9b7-eb8d-497d-b819-90c2f472d71e",
    "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": "2022-08-17T03:09:48.4293446+02:00"
  },
  "work_instruction_details_id": "ae6ab167-c40f-4c84-b6e8-4b76ae5509bb",
  "work_instruction_details_reference_back_office": "sample string 5",
  "user_id": "6c497ef8-2f43-4bee-8e1e-314a8dd04c80",
  "work_instruction_action_type": "sample string 7",
  "work_instruction_id": "2fcabba2-0b49-4d7d-bb99-831b8140b50f",
  "work_instruction_reference_back_office": "sample string 9",
  "name": "sample string 10",
  "status": "sample string 11",
  "date_done": "2022-08-17T03:09:48.4293446+02: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": "8de68ccb-5a9a-4a5d-9a14-d3674771fc3d",
  "db_report_type_name": "sample string 18",
  "modified_dateutc": "2022-08-17T03:09:48.4293446+02:00"
}

Response Information

Resource Description :

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.