Skip to content

custom-objects.md

Latest commit

 

History

History
191 lines (135 loc) · 5.61 KB

custom-objects.md

File metadata and controls

191 lines (135 loc) · 5.61 KB
Raw

Custom Objects

4 operation(s). Part of the API index.

Call these as client.<Service>.<Method>(ctx).Execute(). <service> is the client field for this group — the README lists the field name for every service. These pages group operations the way the OpenAPI specification tags them, which is not always one field per page.

GetAllCustomObjectsByQuery

GET /customobject

Retrieve Custom Object data by pagination

Retrieves Custom Object data based on specified pagination parameters.

Example

func callGetAllCustomObjectsByQuery(ctx context.Context, client *Client) {
  customobject := "<customobject>" //Optional
  region := "<region>" //Optional
  next := "<next>" //Optional

  resp, _, err := client.CustomObjects.GetAllCustomObjectsByQuery(ctx).Customobject(customobject).Region(region).Next(next).Execute()
  if err != nil {
    var lrErr *Error
    if errors.As(err, &lrErr) {
      fmt.Println(lrErr.Description)
    }
    return
  }
  fmt.Println(resp)
}

Parameters

Name In Type Required Description
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
region query string no The region to filter results by.
next query string no Scroll or pagination token for fetching the next set of results. This token is used to retrieve the next page of results in a paginated response. If not provided, the API will return the first page of results.

Returns

UserProfileNextResponse

GetCustomObjectByQuery

GET /identity/customobject

Retrieve User's and Custom Object data by pagination

Retrieves User's and Custom Object data per User based on the pagination parameters.

Example

func callGetCustomObjectByQuery(ctx context.Context, client *Client) {
  region := "<region>" //Optional
  customobject := "<customobject>" //Optional
  next := "<next>" //Optional

  resp, _, err := client.CustomObjects.GetCustomObjectByQuery(ctx).Region(region).Customobject(customobject).Next(next).Execute()
  if err != nil {
    var lrErr *Error
    if errors.As(err, &lrErr) {
      fmt.Println(lrErr.Description)
    }
    return
  }
  fmt.Println(resp)
}

Parameters

Name In Type Required Description
region query string no The region to filter results by.
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
next query string no Scroll or pagination token for fetching the next set of results. This token is used to retrieve the next page of results in a paginated response. If not provided, the API will return the first page of results.

Returns

userProfileNextResponseWithCustomObject

PostAllCustomObjectsByQuery

POST /customobject

Retrieve Custom Object data by query

Retrieves Custom Object data based on specified query filters.

Example

func callPostAllCustomObjectsByQuery(ctx context.Context, client *Client) {
  customobject := "<customobject>" //Optional
  region := "<region>" //Optional
  userProfileRequestBody := UserProfileRequestBody{} //Required
  userProfileRequestBody.SetFrom("<from>")
  userProfileRequestBody.SetTo("<to>")
  userProfileRequestBody.SetSize(0)

  resp, _, err := client.CustomObjects.PostAllCustomObjectsByQuery(ctx).Customobject(customobject).Region(region).UserProfileRequestBody(userProfileRequestBody).Execute()
  if err != nil {
    var lrErr *Error
    if errors.As(err, &lrErr) {
      fmt.Println(lrErr.Description)
    }
    return
  }
  fmt.Println(resp)
}

Parameters

Name In Type Required Description
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.
region query string no The region to filter results by.

Request body

UserProfileRequestBody as application/json.

Returns

UserProfileScrollResponse

PostCustomObjectByQuery

POST /identity/customobject

Retrieve User's and Custom Object data by query

Retrieves User's and Custom Objects data per User based on the query.

Example

func callPostCustomObjectByQuery(ctx context.Context, client *Client) {
  region := "<region>" //Optional
  customobject := "<customobject>" //Optional
  userProfileRequestBody := UserProfileRequestBody{} //Required
  userProfileRequestBody.SetFrom("<from>")
  userProfileRequestBody.SetTo("<to>")
  userProfileRequestBody.SetSize(0)

  resp, _, err := client.CustomObjects.PostCustomObjectByQuery(ctx).Region(region).Customobject(customobject).UserProfileRequestBody(userProfileRequestBody).Execute()
  if err != nil {
    var lrErr *Error
    if errors.As(err, &lrErr) {
      fmt.Println(lrErr.Description)
    }
    return
  }
  fmt.Println(resp)
}

Parameters

Name In Type Required Description
region query string no The region to filter results by.
customobject query string no Custom Object identifier for filtering results. This parameter allows you to specify a Custom Object to filter the results returned by the API.

Request body

UserProfileRequestBody as application/json.

Returns

userProfileScrollResponseWithCustomObject