Contents x
    /Endpoint/rest/api/v1/User/{Id}/Departments
    • 18 Oct 2024
    • 8 Minutes to read
    • Print
    • Dark
      Light
    Contents

    /Endpoint/rest/api/v1/User/{Id}/Departments

    • Updated on 18 Oct 2024
    • 8 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Patch
    /Endpoint/rest/api/v1/User/{Id}/Departments

    Use the DepartmentsData object resource to insert or update (Upsert) a list of DepartmentData using Id, UserId.Email, UserId.Username field(s) value.

    You can supply the required field values in the request data, and then use the POST method of the resource.

    The input parameter must be used in the DepartmentList record structure as text fields in the foreign key fields.

    Foreign key fields are: DepartmentId, UserId, ModifiedBy, CreatedBy

    Update a record of Department

    • If the UserId.Email, UserId.Username field value is not empty and Id field value is empty, action try insert record according UserId.Email, UserId.Username field value (if set, the value is a unique identifier).

    Attention!, this can also cause an incorrect row update, but at the same time enables efficient data transfer between systems.

    Create a new record of Department

    • If the value in the UserId.Email, UserId.Username and Id fields are empty then action insert a new record according input parameter entity record structure (DepartmentData).

    The response body will contain the record list structure of the updated or created record if the call is successful. The method returns a list structured with an extended Department representation. In this format, all foreign key fields are depicted as abstract object structures, employing AbstractText or AbstractLong data types. This offers an enriched and detailed perspective of the data and its associated entities.

    Security
    OAuth

    oAuth autentication flow

    FlowClient Credentials
    Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Path parameters
    Id
    stringRequired

    The identifier of the User record. The parameter is part of the url address and some special characters are forbidden.

    You can extract any string to a base64 string. E.g email address name@domain.com value is base64|bmFtZUBkb21haW4uY29t

    Query parameters
    Name
    string

    The name of the database field. If empty, the entity Id field is used.

    Example:

    Id
    DeleteNotExists
    string

    The Delete not exists function delete orphan values from a table.

    If you specify value, you do not need to manually delete orphan rows from the table, the service retrieves the result set and if it is not found from the json string, then delete orphan rows from the table.

    Default"false"
    Body parameters

    The list of Department information to insert or update.

    The input parameter must be used in the Extra record array structure inside the Name and FieldName parameters in the foreign key fields.

    Expand All
    object

    The data loading record of Department importing

    Extra
    Array of object (ListValidation)

    List validation for entity attribute

    object

    List validation for entity attribute

    Name
    string Required

    The name of the entity field.

    FieldName
    string

    The field name of relation database table.

    Example; The field name is 'TenantId' and is associated with the 'Tenant' table. You want to use in the 'Tenant' table 'Name' field fetching data. Once 'Name' is specified, the validation service retrieves the tenant identifier from the 'Tenant' table based on the 'Name' field.

    Required
    boolean

    If True, the value is required.

    Defaultfalse
    ExampleFalse
    Unique
    boolean

    If True, the value must be unique in the database and you cannot add multiple values.

    Defaultfalse
    ExampleFalse
    Max
    string

    The max value of input value.

    Min
    string

    The min value of input value.

    Pattern
    string

    The pattern of the validation. Searches the input string for an occurrence of a regular expression.

    DefaultValue
    string

    The default value of row. If the value of the field is empty, the service automatically sets the value in the field. If the value does not match the data type, the value is cleaned. Remember data types.

    IsFullValidation
    boolean

    If the value is true, the data quality of all fields are checked. This has an effect on performance.

    Defaultfalse
    ExampleFalse
    Departments
    Array of object (DepartmentText)

    The list of Department data record for import

    object

    The record of Department information.

    DepartmentId
    string

    The identifier of the department.

    Responses
    200

    Inserted or updated list of Department information.

    Expand All
    object

    The list of Department records

    Meta
    object (Meta)

    The object provides metadata about the list of items returned in the API response. It typically includes information that helps clients understand and work with the data.

    TotalItems
    integer (int32)

    This field represents the total number of items available in the entire dataset, not just the items returned in the current response. It's useful for implementing pagination, as clients can use it to calculate the number of pages or total available items.

    Default0
    Example1000
    CurrentPage
    integer (int32)

    This field specifies the current page of results being returned. It's often used in conjunction with PageSize to manage pagination by indicating which subset of the total data is currently being retrieved.

    Default1
    Example50
    PageSize
    integer (int32)

    The field indicates the number of items returned in a single page or response. It helps clients determine how many items to display per page and how to request additional pages if needed.

    Default50
    Example50
    Type
    string

    The type of the record

    ExampleUser
    Data
    Array of object (Department)

    The list of Department records

    object

    The record of Department information.

    Id
    string

    The guid to identify the department

    ExternalId
    string

    The external identifier of the department

    Name
    string

    The name of the department

    DepartmentTypeId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    ParentDepartmentId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    HierarchicalName
    string

    The hierarchical name of the department

    Level
    integer (int32)

    The department level at the hierarchy

    Default0
    Example0
    ContactName
    string

    The contact name of company or department

    ContactEmail
    string

    The contact email of external company or department

    ContactPhone
    string
    CountryId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    Is_Active
    boolean

    Defines if the department is active and can be used

    Defaultfalse
    ExampleFalse
    ModifiedOn
    string (date-time)

    The date the record was updated

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    CreatedOn
    string (date-time)

    The date the record was created

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    400

    Bad Request - The user has provided input that the browser is unable to convert.

    {
  "Errors": [
    "The user has provided input that the browser is unable to convert.",
    "There are multiple rows in the database for the same value",
    "The value does not match the specified entity structure",
    "..."
  ],
  "Type": "/Errors/Bad Input",
  "Title": "Bad Request",
  "StatusCode": 400,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    401

    Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

    {
  "Errors": [
    "The session Id or OAuth token used has expired or is invalid."
  ],
  "Type": "/Errors/Unauthorized",
  "Title": "Unauthorized",
  "StatusCode": 401,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    403

    Forbidden - The user does not have access to execute operation

    {
  "Errors": [
    "The user does not have access to execute operation"
  ],
  "Type": "/Errors/Permission",
  "Title": "Bad Request",
  "StatusCode": 403,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    500

    Internal Server Error - An internal server error is an error on the web server you're trying to access.

    {
  "Errors": [
    "An internal server error is an error on the web server you're trying to access."
  ],
  "Type": "/Errors/Internal Server Error",
  "Title": "Internal Server Error",
  "StatusCode": 500,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    Was this article helpful?
    What's Next
    Streamline your low-code application development processes to improve quality and productivity.

    Agile.Now


    Company


    Sales and Support

    © 2021 eSystems Nordic Oy - All rights reserved