diff --git a/src/docs/version_002/resources/apps/get_apps_by_ids/copy.md b/src/docs/version_002/resources/apps/get_apps_by_ids/copy.md index 960677b..9f6e440 100644 --- a/src/docs/version_002/resources/apps/get_apps_by_ids/copy.md +++ b/src/docs/version_002/resources/apps/get_apps_by_ids/copy.md @@ -1,6 +1,6 @@ # Get Apps by Ids {% #get-apps-by-ids %} -This endpoint returns a batch of [apps](#apps) based on the given app ids. +This endpoint returns a batch of [apps](#apps) based on the given app ids. The max number of apps that can be requested is 100. ## Request Body diff --git a/src/docs/version_002/resources/fields/get_fields_by_app/copy.md b/src/docs/version_002/resources/fields/get_fields_by_app/copy.md index abc653b..94bc5ed 100644 --- a/src/docs/version_002/resources/fields/get_fields_by_app/copy.md +++ b/src/docs/version_002/resources/fields/get_fields_by_app/copy.md @@ -1,6 +1,6 @@ # Get Fields by App {% #get-fields-by-app %} -This endpoint returns a [paged](#pagination) collection of [fields](#fields) for the given app. +This endpoint returns a [paged](#pagination) collection of [Fields](#fields) for the given app. ## Path Parameters diff --git a/src/docs/version_002/resources/fields/get_fields_by_ids/copy.md b/src/docs/version_002/resources/fields/get_fields_by_ids/copy.md index f3ad2e2..48cd67e 100644 --- a/src/docs/version_002/resources/fields/get_fields_by_ids/copy.md +++ b/src/docs/version_002/resources/fields/get_fields_by_ids/copy.md @@ -1 +1,35 @@ # Get Fields by Ids {% #get-fields-by-ids %} + +This endpoint returns a batch of [Fields](#fields) by their ids. The max number of fields that can be requested is 100. + +## Request Body + +{% code heading="REQUEST" defaultLanguage="json" %} + +```json +[6983, 6986, 6987, 6985, 6984] +``` + +{% /code %} + +## Response Body Properties + +{% table %} + +- Property Name +- Data Type +- Description + +--- + +- count +- `number` +- The number of fields returned. + +--- + +- items +- `object[]` +- The [fields](#fields) returned. + +{% /table %} diff --git a/src/docs/version_002/resources/fields/get_fields_by_ids/example.md b/src/docs/version_002/resources/fields/get_fields_by_ids/example.md index d14e154..9311584 100644 --- a/src/docs/version_002/resources/fields/get_fields_by_ids/example.md +++ b/src/docs/version_002/resources/fields/get_fields_by_ids/example.md @@ -1 +1,87 @@ # Retrieve a batch of fields by ids + +{% code method="POST" heading="/Fields/batch-get" defaultLanguage="bash" %} + +```bash +curl --location 'https://api.onspring.com/Fields/batch-get' \ +--header 'X-ApiKey: 000000ffffff000000ffffff/00000000-ffff-0000-ffff-000000000000' \ +--header 'Content-Type: application/json' \ +--data '[6983,6986,6987,6985,6984]' +``` + +```csharp +using Onspring.API.SDK; + +var onspringClient = new OnspringClient( + config.BaseUrl, + config.ApiKey +); + +var response = onspringClient.GetFieldsAsync(new List { 6983, 6986, 6987, 6985, 6984 }); + +foreach (var field in response.Value.Items) +{ + Console.WriteLine($"{field.Id}"); +} +``` + +```javascript +import { OnspringClient } from 'onspring-api-sdk'; +import dotenv from 'dotenv'; +dotenv.config(); + +const client = new OnspringClient( + process.env.BASE_URL, + process.env.API_KEY +); + +const res = await client.getFieldsByIds([4793, 4801]); +const fields = res.data.items; + +for (const field of fields) { + console.log(field); +} +``` + +```python +from OnspringApiSdk.OnspringClient import OnspringClient +from configparser import ConfigParser + +cfg = ConfigParser() +cfg.read('config.ini') + +key = cfg['prod']['key'] +url = cfg['prod']['url'] + +client = OnspringClient(url, key) +response = client.GetFieldsByIds(fieldIds=[6983, 6986, 6987, 6985, 6984]) + +print(f'Status Code: {response.statusCode}') +print(f'Count: {response.data.count}') + +for field in response.data.fields: + print(f'Field Id: {field.id}') +``` + +{% /code %} + +{% code heading="RESPONSE" defaultLanguage="json" %} + +```json +{ + "count": 1, + "items": [ + { + "id": 6983, + "appId": 195, + "name": "Name", + "type": "Text", + "status": "Enabled", + "isRequired": false, + "isUnique": false + } + ] +} +``` + +{% /code %} diff --git a/src/docs/version_002/resources/records/get_records_by_ids/copy.md b/src/docs/version_002/resources/records/get_records_by_ids/copy.md index 36f66c6..278a979 100644 --- a/src/docs/version_002/resources/records/get_records_by_ids/copy.md +++ b/src/docs/version_002/resources/records/get_records_by_ids/copy.md @@ -1,6 +1,6 @@ # Get Records by Ids {% #get-records-by-ids %} -This endpoint returns a batch of [records](#records) that match the given ids. +This endpoint returns a batch of [records](#records) that match the given ids. The max number of records that can be requested is 100. ## Request Body Properties