Oracle Fusion Cloud HCM REST API

https://docs.oracle.com/en/cloud/saas/human-resources/farws/
Admin
Oracle Fusion Cloud HCM REST API is a comprehensive API documentation for managing human capital...
Tokens:2,730,880
Snippets:20,177
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get a questionnaire setup

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingcontentlibraryitemslov-recruitingcontentlibraryitemslovuniqid-child-descriptions-descriptionversionid-enclosure-shortdescription-get.html

Retrieves the setup configuration of a questionnaire.

```APIDOC
## GET /employeeEvents/{eventId}/questionnaires/{questionnaireId}/setup

### Description
Returns the setup configuration of a specific questionnaire.

### Method
GET

### Endpoint
/employeeEvents/{eventId}/questionnaires/{questionnaireId}/setup

### Parameters
#### Path Parameters
- **eventId** (integer) - Required - The unique identifier of the employee event.
- **questionnaireId** (integer) - Required - The unique identifier of the questionnaire.

### Response
#### Success Response (200)
- **setup** (object) - The setup configuration.

#### Response Example
{
  "setup": {}
}
```

--------------------------------

### Response Body Example

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-workers-workersuniqid-child-ethnicities-ethnicityid-get.html

An example of the JSON response body containing worker ethnicity details.

```json
{
    "EthnicityId": 300100188720764,
    "PrimaryFlag": true,
    "LegislationCode": "US",
    "Ethnicity": "8",
    "CreatedBy": "VMOSS",
    "CreationDate": "2019-05-16T13:32:25+00:00",
    "LastUpdatedBy": "VMOSS",
    "LastUpdateDate": "2019-05-16T13:32:25.281+00:00",
    "links": [
        {...
             }
   ]
}
```

--------------------------------

### Recruiting Tax Credits Candidate Details

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-workers-workersuniqid-child-ethnicities-ethnicityid-get.html

Operations to get details for job applications and candidate address details.

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails/{applicationId}

### Description
Retrieves details for a specific job application.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails/{applicationId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the job application.

### Response
#### Success Response (200)
- **applicationId** (string) - The unique identifier.
- **candidateDetails** (object) - Candidate details.

#### Response Example
{
  "applicationId": "app1",
  "candidateDetails": {}
}

```

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails

### Description
Retrieves details for all job applications.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails

### Response
#### Success Response (200)
- **items** (array) - List of job application details.

#### Response Example
{
  "items": []
}

```

--------------------------------

### Recruiting Tax Credits Address Format

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-workers-workersuniqid-child-ethnicities-ethnicityid-get.html

Operations to get all address formats of the candidate and a specific address format.

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails/{applicationId}/addressFormats

### Description
Retrieves all address formats of the candidate.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails/{applicationId}/addressFormats

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the job application.

### Response
#### Success Response (200)
- **items** (array) - List of address formats.

#### Response Example
{
  "items": []
}

```

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails/{applicationId}/addressFormats/{formatId}

### Description
Retrieves a specific address format of the candidate.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails/{applicationId}/addressFormats/{formatId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the job application.
- **formatId** (string) - Required - The unique identifier of the address format.

### Response
#### Success Response (200)
- **formatId** (string) - The unique identifier.
- **formatName** (string) - Name of the format.

#### Response Example
{
  "formatId": "fmt1",
  "formatName": "US Format"
}

```

--------------------------------

### Recruiting Tax Credits Address Details

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-workers-workersuniqid-child-ethnicities-ethnicityid-get.html

Operations to get all address details of a candidate and a specific address detail.

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails/{applicationId}/addressDetails

### Description
Retrieves all address details of the candidate for a job application.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails/{applicationId}/addressDetails

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the job application.

### Response
#### Success Response (200)
- **items** (array) - List of address details.

#### Response Example
{
  "items": []
}

```

```APIDOC
## GET /recruitingTaxCreditsCandidateDetails/{applicationId}/addressDetails/{addressId}

### Description
Retrieves a specific address detail of the candidate.

### Method
GET

### Endpoint
/recruitingTaxCreditsCandidateDetails/{applicationId}/addressDetails/{addressId}

### Parameters
#### Path Parameters
- **applicationId** (string) - Required - The unique identifier of the job application.
- **addressId** (string) - Required - The unique identifier of the address detail.

### Response
#### Success Response (200)
- **addressId** (string) - The unique identifier.
- **addressLine1** (string) - First line of the address.

#### Response Example
{
  "addressId": "addr1",
  "addressLine1": "123 Main St"
}

```

--------------------------------

### Example Response Header

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingcandidates-candidatenumber-child-licensesandcertificates-get.html

Example HTTP response header returned by the GET request.

```http
HTTP/1.1 200 OK
Content-Type : application/vnd.oracle.adf.resourceitem+json
```

--------------------------------

### GET /hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings/{SettingKey}

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingoppmktsettings-settingkey-get.html

Documentation for the GET operation to retrieve a specific opportunity marketplace setting by its key.

```APIDOC
## [GET] /hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings/{SettingKey}

### Description
Retrieves a specific setting for the opportunity marketplace using its unique key. The key is a hash value that should be obtained by querying the collection resource.

### Method
GET

### Endpoint
/hcmRestApi/resources/11.13.18.05/recruitingOppMktSettings/{SettingKey}

### Parameters
#### Path Parameters
- **SettingKey** (string) - Required - The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

#### Query Parameters
- **dependency** (string) - Optional - This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2  
  Format: <attr1>=<val1>,<attr2>=<value2>
- **expand** (string) - Optional - When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
- **fields** (string) - Optional - This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.  
  Format: ?fields=Attribute1,Attribute2  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
- **links** (string) - Optional - This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>  
  Example:  
  self,canonical  
- **onlyData** (boolean) - Optional - The resource item payload will be filtered in order to contain only data (no links section, for example).

#### Header Parameters
- **Metadata-Context** (string) - Optional - If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
- **REST-Framework-Version** (string) - Optional - The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

### Request Example
There's no request body for this operation.

### Response
#### Success Response (200)
No response schema is provided in the source documentation.

#### Response Example
No response example is provided in the source documentation.
```

--------------------------------

### Get User Accounts response example

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-useraccountslov-get.html

Example response payload for the Get User Accounts operation, showing a list of user account objects with fields such as UserId, Username, Suspended, ActiveFlag, ObjectVersionNumber, and links. The links array is abbreviated with an ellipsis.

```json
{
      "UserId": 100010034074292,
      "Username": "PROJECT_ADMINISTRATOR_VISION_SERVICES",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100437,
      "Username": "PROJECT_ADMINISTRATOR_VISION_STORES_US",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100443,
      "Username": "PROJECT_BILLING_SPECIALIST_VISION_PROJECT_MFG",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100451,
      "Username": "PROJECT_BILLING_SPEC_FUSION_CORP_USA",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100453,
      "Username": "PROJECT_BILLING_SPEC_OPERATIONS",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100461,
      "Username": "PROJECT_BILLING_SPEC_SERVICES_R_AND_D",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 157,
      "Username": "PROJECT_CREATOR_FACILITY_OPERATIONS",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 32,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100463,
      "Username": "PROJECT_CREATOR_FUSION_CORP_USA",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 3,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100010032639696,
      "Username": "PROJECT_CREATOR_PROJECT",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 3,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100000018100471,
      "Username": "PROJECT_CREATOR_SERVICES_SOUTH",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100010032639743,
      "Username": "PSRUSER044",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100010032639751,
      "Username": "PSRUSER052",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100010032639759,
      "Username": "PSRUSER060",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    },
    {
      "UserId": 100010032639767,
      "Username": "PSRUSER068",
      "Suspended": "N",
      "ActiveFlag": true,
      "ObjectVersionNumber": 2,
      "links" : [ 
          {
            ...}
      ]
    }
  ]
}
```

--------------------------------

### Create all widget setting details

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingceofferdetails-offerid-child-offerdeclinereasons-reasonid-get.html

Creates all settings for a custom widget in a theme.

```APIDOC
## POST /recruitingCEThemes/{themeId}/widgets/{widgetId}/settings

### Description
Creates all settings for a custom widget in a theme.

### Method
POST

### Endpoint
/recruitingCEThemes/{themeId}/widgets/{widgetId}/settings

```

--------------------------------

### Create all widget details

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingceofferdetails-offerid-child-offerdeclinereasons-reasonid-get.html

Creates all custom widget details for a theme.

```APIDOC
## POST /recruitingCEThemes/{themeId}/widgets

### Description
Creates all custom widget details for a theme.

### Method
POST

### Endpoint
/recruitingCEThemes/{themeId}/widgets

```

--------------------------------

### cURL GET request for userAccountsLOV

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-useraccountslov-get.html

Example cURL command to retrieve all user accounts by sending a GET request to the userAccountsLOV REST resource.

```bash
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/userAccountsLOV"
```

--------------------------------

### Response header for languages GET

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingjobrequisitions-recruitingjobrequisitionsuniqid-child-languages-get.html

Example response header for the GET request, showing HTTP 200 OK and the content type application/vnd.oracle.adf.resourceitem+json.

```http
HTTP/1.1 200 OK                                                      
Content-Type : application/vnd.oracle.adf.resourceitem+json
```

--------------------------------

### GET recruitingOppMktSettings/{settingKey}

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingoppmktsettings-settingkey-get.html

Retrieves a specific recruiting opportunity marketplace setting by its key. The response includes the setting key, value, and related links.

```APIDOC
## GET recruitingOppMktSettings/{settingKey}

### Description
Retrieves a specific recruiting opportunity marketplace setting by its key. The response includes the setting key, value, and related links.

### Method
GET

### Endpoint
recruitingOppMktSettings/{settingKey}

### Parameters
#### Path Parameters
- **settingKey** (string) - Required - The key of the setting to retrieve.

### Response
#### Success Response (200)
- **SettingKey** (string) - Key of a setting in opportunity marketplace. Maximum length: 255.
- **SettingValue** (string) - Value of a setting in opportunity marketplace.
- **links** (array) - The link relations associated with the resource instance.

#### Response Example
```json
{
  "SettingKey": "string",
  "SettingValue": "string",
  "links": [
    {
      "kind": "item",
      "rel": "self",
      "name": "string",
      "href": "string",
      "properties": {
        "changeIndicator": "string"
      }
    }
  ]
}
```

### Error Handling
No error responses are documented in the source.
```

--------------------------------

### GET /hcmRestApi/resources/11.13.18.05/salaryBasisLov

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-salarybasislov-salarybasisid-get.html

Retrieves salary basis information by submitting a GET request on the REST resource. The example uses a query parameter to filter by SalaryBasisId.

```APIDOC
## GET /hcmRestApi/resources/11.13.18.05/salaryBasisLov

### Description
Retrieves salary basis information by submitting a GET request on the REST resource. The example uses a query parameter to filter by SalaryBasisId.

### Method
GET

### Endpoint
/hcmRestApi/resources/11.13.18.05/salaryBasisLov

### Parameters
#### Query Parameters
- **q** (string) - Optional - Query expression to filter results. Example: `SalaryBasisId=300100001799079`

### Request Example
```
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -H "REST-Framework-Version: 4" -X GET "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov?q=SalaryBasisId=300100001799079"
```

### Response
#### Success Response (200)
- **items** (array) - List of salary basis objects.
- **count** (number) - Number of items returned.
- **hasMore** (boolean) - Indicates if more results are available.
- **limit** (number) - Maximum number of items per page.
- **offset** (number) - Offset for pagination.
- **links** (array) - Links to related resources.

#### Response Example
```
{
    "items": [
        {
            "SalaryBasisName": "ZCMP US STD Salary Annually Comp",
            "SalaryBasisId": 300100001799079,
            "FrequencyCode": "ANNUAL",
            "FrequencyName": "Annually",
            "Code": "ZCMP_US_STD_Salary_Annually_Comp",
            "Status": "A",
            "SalaryBasisType": "C",
            "ComponentUsage": "SELECTED_COMPONENTS",
            "AnnualizationFactor": 1,
            "SalaryAmountScale": 2,
            "GradeRateId": 100000012474204,
            "InputCurrencyCode": "USD",
            "ElementTypeId": 300100001860147,
            "LegislativeDataGroupId": 100010027007985,
            "UseAtRelationshipLevel": "N",
            "UseAtTermsLevel": "N",
            "UseAtAssignmentLevel": "Y",
            "links": [
                {
                    "rel": "self",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167715D5000780000000EACED00057708000110F07A011BA7",
                    "name": "salaryBasisLov",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167715D5000780000000EACED00057708000110F07A011BA7",
                    "name": "salaryBasisLov",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov/00020000004AACED00057372000D6A6176612E73716C2E4461746514FA46683F3566970200007872000E6A6176612E7574696C2E44617465686A81014B5974190300007870770800000167715D5000780000000EACED00057708000110F07A011BA7/child/salaryBasisComponents",
                    "name": "salaryBasisComponents",
                    "kind": "collection"
                }
            ]
        }
    ],
    "count": 1,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://<host>:<port>/hcmRestApi/resources/11.13.18.05/salaryBasisLov",
            "name": "salaryBasisLov",
            "kind": "collection"
        }
    ]
}
```

### Error Handling
No error responses are documented in the source.
```

--------------------------------

### Create a geofence

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingceusertrackings-post.html

Creates a new geofence.

```APIDOC
## POST /geofences

### Description
Creates a new geofence.

### Method
POST

### Endpoint
/geofences

### Request Body
- **geofence** (object) - Required - The geofence object to create.

### Response
#### Success Response (201)
Returns the created geofence.

```

--------------------------------

### Create details of recruitingCEThemes Header Settings

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingceofferdetails-offerid-child-offerdeclinereasons-reasonid-get.html

Creates settings for a custom header in a theme.

```APIDOC
## POST /recruitingCEThemes/{themeId}/headers/{headerId}/settings

### Description
Creates settings for a custom header in a theme.

### Method
POST

### Endpoint
/recruitingCEThemes/{themeId}/headers/{headerId}/settings

```

--------------------------------

### Response header for candidate attachments GET

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingcandidates-candidatenumber-child-attachments-get.html

Example response header returned by the GET request. The HTTP status is 200 OK and the Content-Type is application/vnd.oracle.adf.resourceitem+json.

```http
HTTP/1.1 200 OK                                                      
Content-Type : application/vnd.oracle.adf.resourceitem+json

```

--------------------------------

### Response body for GET request

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-talentpersonprofiles-talentpersonprofilesuniqid-child-accomplishmentsections-profilesectionid-get.html

Example response body in JSON format for the GET request, showing the accomplishment section details and a Links array placeholder.

```json
{
  "ProfileSectionId": 300100195139390,
  "SectionId": 300100195105767,
  "SectionContext": "COMPETENCY_300100195105767",
  "SectionName": "AK Competency",
  "CreatedBy": "ZANC_ZBEN_SUPER_USER",
  "CreationDate": "2020-07-03T08:12:05+00:00",
  "LastUpdatedBy": "ZANC_ZBEN_SUPER_USER",
  "LastUpdateDate": "2020-07-03T08:12:05.052+00:00",
  "Links" : [
     {
        ..},
   ]
}
```

--------------------------------

### GET /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/ActivitySummary

Source: https://docs.oracle.com/en/cloud/saas/human-resources/farws/op-recruitingpartnercandidatedetails-candidatetoken-child-educations-educationid-enclosure-activitysummary-get.html

Retrieves an ActivitySummary for a specific education enclosure of a recruiting partner candidate. The response is a binary stream.

```APIDOC
## GET /hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/ActivitySummary

### Description
Get an ActivitySummary for a specific education enclosure of a recruiting partner candidate.

### Method
GET

### Endpoint
/hcmRestApi/resources/11.13.18.05/recruitingPartnerCandidateDetails/{CandidateToken}/child/educations/{EducationId}/enclosure/ActivitySummary

### Parameters
#### Path Parameters
- **CandidateToken** (string) - Required - The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
- **EducationId** (integer) - Required - The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

### Request
There's no request body for this operation.

### Response
#### Supported Media Types
- application/octet-stream

#### Default Response
Body (schema)

Root Schema : schema
Type: string(binary)

```
Tokens:
Raw