Retrieve Company Access By Company Code and User ID

Prev Next
Get
/sys-rest-api/rest/1/sdcompanyaccess

Get Company Access By Company Code and User ID
This endpoint retrieves users' company access information with the option to filter and optimize the request performance using the following parameters:

Finder Name:
SdCompanyAccessFinder

Request Parameters:
UserID (query parameter) - User assigned to Company
CompCode (query parameter) -Company Code

Response Body:
The response will contain the details of the company access in the JSON format. Here is an example of the response body:

{
"CompsecCompCode": "",
"CompsecCompName": "",
"CompsecUser": "",
"CompsecVUuid": "",
"links": [
{
"rel": "",
"href": "",
"name": "",
"kind": ""
}
         ]
}

Security
HTTP
Type basic

Basic authentication

Query parameters
limit
integer
Example25
offset
integer
Example0
totalResults
boolean
Exampletrue
finder
string
ExampleSdCompanyAccessFinder; UserID=IBRAHIM,CompCode =ZZ
Responses
200

OK

Headers
Content-Type
string
Exampleapplication/vnd.oracle.adf.resourcecollection+json
{
  "items": [
    {
      "CompsecCompCode": "ZZ",
      "CompsecCompName": "CMiC-ZZ  Test Company Incorp",
      "CompsecUser": "IBRAHIM2",
      "CompsecVUuid": "37C75EA13244BB82E0630B811DACFF10",
      "links": [
        {
          "rel": "self",
          "href": "http://localhost:7101/sys-rest-api/rest/1/sdcompanyaccess/37C75EA13244BB82E0630B811DACFF10",
          "name": "sdcompanyaccess",
          "kind": "item"
        },
        {
          "rel": "canonical",
          "href": "http://localhost:7101/sys-rest-api/rest/1/sdcompanyaccess/37C75EA13244BB82E0630B811DACFF10",
          "name": "sdcompanyaccess",
          "kind": "item"
        }
      ]
    }
  ],
  "totalResults": 1,
  "count": 1,
  "hasMore": false,
  "limit": 25,
  "offset": 0,
  "links": [
    {
      "rel": "self",
      "href": "http://localhost:7101/sys-rest-api/rest/1/sdcompanyaccess",
      "name": "sdcompanyaccess",
      "kind": "collection"
    }
  ]
}
object
Copyright © 2024 CMiC All Rights Reserved