--- title: "/Endpoint/rest/api/v1/AccessGroup" slug: "endpointrestapiv1accessgroup-2" updated: 2024-12-18T10:21:23Z published: 2024-12-18T10:21:23Z canonical: "docs.agilenow.io/endpointrestapiv1accessgroup-2" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.agilenow.io/llms.txt > Use this file to discover all available pages before exploring further. # /Endpoint/rest/api/v1/AccessGroup Patch/Endpoint/rest/api/v1/AccessGroup Use the `AccessGroupData` object resource to insert or update (Upsert) `AccessGroup` using `Id, Name` 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 `AccessGroupData` record structure inside the `FieldType` parameter in the foreign key fields. Foreign key fields are: `AccessGroupTypeId, ModifiedBy, CreatedBy` ### Update a record of AccessGroup - If the `Id` field value is not matched, then a `404` error is reported (`Errors/Not Found`), and the error record is returned.. You cannot change `Id` field value (primary key). - If the `Name` field value is not empty and `Id` field value is empty, action try insert record according `Name` field value (if set, the value is a unique identifier). ### Create a new record of AccessGroup - If the value in the `Name` and `Id` fields are empty then action insert a new record according input parameter entity record structure (`AccessGroupData`). The response body will contain the object of the updated or created record if the call is successful. Method returns an extended `AccessGroup` structure. Here, all foreign key fields are abstract object structures, utilizing `AbstractText` or `AbstractLong` data types, offering a detailed view of the data and related entities. SecurityOAuth oAuth autentication flow FlowClient Credentials Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token Scopes:AccessManager:Create, UpdateAllows to edit access groups and all related data. (ABAC) permissions required to perform a function. AccessUser:Create, UpdateAllows to review access groups and all related data. (ABAC) permissions required to perform a function. Body parameters `AccessGroup` information to insert or update. The input parameter must be used in the `AccessGroupData` record structure inside the `FieldType` parameter in the foreign key fields. object The record of AccessGroup information. Idstring The identifier of access group. Namestring The name of access group. ExternalIdstring The external system code of the access group. Descriptionstring The description of access group. Is_Activeboolean Defines if record is active. DefaultfalseExampleFalse AccessGroupTypeIdstring The enum of AccessGroupType. Valid values[ "FullAccess", "Locations", "Departments" ] Responses200 Inserted or updated `AccessGroup` information. Expand Allobject The record of AccessGroup information. Idstring The identifier of access group Namestring The name of access group ExternalIdstring The external system code of the access group Descriptionstring The description of access group Is_Activeboolean Defines if record is active DefaultfalseExampleFalse Is_Systemboolean Defines if access group is system and end-user cannot change it general, permissions and applications. DefaultfalseExampleFalse AccessGroupTypeIdobject (AbstractText) This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities. Idstring 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 ExternalIdstring 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 Namestring 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 Typestring 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 ModifiedOnstring (date-time) The date the record was updated Default"1900-01-01T12:00:00Z"Example1900-01-01T12:00:00Z ModifiedByobject (AbstractLong) This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities. Idinteger (int64) 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. Default0Example1234567891234567 ExternalIdstring 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 Namestring 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 Typestring 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 CreatedByobject (AbstractLong) This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities. Idinteger (int64) 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. Default0Example1234567891234567 ExternalIdstring 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 Namestring 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 Typestring 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 CreatedOnstring (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. ```json { "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"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring 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. ```json { "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"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default"" 403 Forbidden - The user does not have access to execute operation ```json { "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"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring 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. ```json { "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"" Typestring URI identifier that categorizes the error Default"" Titlestring Brief, human-readable message about the error Default"" StatusCodeinteger (int32) The HTTP response code Example400 Instancestring URI that identifies the specific occurrence of the error Default"" RequestKeystring Provides a request key that identifies the current request. Default""