Skip to content

Latest commit

 

History

History
553 lines (338 loc) · 14.4 KB

AccessoriesApi.md

File metadata and controls

553 lines (338 loc) · 14.4 KB
Raw

\AccessoriesApi

All URIs are relative to http://localhost

Method HTTP request Description
ApiV3AccessoriesGet Get /api/v3/accessories
ApiV3AccessoriesIdentChangesHistoryGet Get /api/v3/accessories/{ident}/changes-history
ApiV3AccessoriesIdentDelete Delete /api/v3/accessories/{ident}
ApiV3AccessoriesIdentGet Get /api/v3/accessories/{ident}
ApiV3AccessoriesIdentPatch Patch /api/v3/accessories/{ident}
ApiV3AccessoriesPost Post /api/v3/accessories
ApiV3AccessoriesSavedsearchesGet Get /api/v3/accessories/savedsearches
ApiV3AccessoriesSavedsearchesIdentGet Get /api/v3/accessories/savedsearches/{ident}

ApiV3AccessoriesGet

ApiV3AccessoriesGet(ctx).Limit(limit).Skip(skip).Sortby(sortby).Filter(filter).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    limit := "limit_example" // string | Limit records (optional)
    skip := "skip_example" // string | Skip records (optional)
    sortby := "sortby_example" // string | Order for results (optional)
    filter := "filter_example" // string | Regular API v3 filter expression (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesGet(context.Background()).Limit(limit).Skip(skip).Sortby(sortby).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesGetRequest struct via the builder pattern

Name Type Description Notes
limit string Limit records
skip string Skip records
sortby string Order for results
filter string Regular API v3 filter expression

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesIdentChangesHistoryGet

ApiV3AccessoriesIdentChangesHistoryGet(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesIdentChangesHistoryGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesIdentChangesHistoryGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesIdentChangesHistoryGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesIdentDelete

ApiV3AccessoriesIdentDelete(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesIdentDelete(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesIdentDelete``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesIdentDeleteRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesIdentGet

ApiV3AccessoriesIdentGet(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesIdentGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesIdentGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesIdentGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesIdentPatch

ApiV3AccessoriesIdentPatch(ctx, ident).Accessory(accessory).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)
    accessory := *openapiclient.NewAccessory() // Accessory |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesIdentPatch(context.Background(), ident).Accessory(accessory).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesIdentPatch``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesIdentPatchRequest struct via the builder pattern

Name Type Description Notes

accessory | Accessory | |

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesPost

ApiV3AccessoriesPost(ctx).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Accessory(accessory).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    oomnitzaIgnoreMetaRestriction := "oomnitzaIgnoreMetaRestriction_example" // string | Used to allow the non-system edit-only field to be updated. Allowed values: 0, 1 (optional)
    accessory := *openapiclient.NewAccessory() // Accessory |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesPost(context.Background()).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Accessory(accessory).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesPost``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesPostRequest struct via the builder pattern

Name Type Description Notes
oomnitzaIgnoreMetaRestriction string Used to allow the non-system edit-only field to be updated. Allowed values: 0, 1
accessory Accessory

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: application/json
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesSavedsearchesGet

ApiV3AccessoriesSavedsearchesGet(ctx).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesSavedsearchesGet(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesSavedsearchesGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesSavedsearchesGetRequest struct via the builder pattern

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ApiV3AccessoriesSavedsearchesIdentGet

ApiV3AccessoriesSavedsearchesIdentGet(ctx, ident).Execute()

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "./openapi"
)

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.AccessoriesApi.ApiV3AccessoriesSavedsearchesIdentGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `AccessoriesApi.ApiV3AccessoriesSavedsearchesIdentGet``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
ident string ID of system object (assets, locations, ...)

Other Parameters

Other parameters are passed through a pointer to a apiApiV3AccessoriesSavedsearchesIdentGetRequest struct via the builder pattern

Name Type Description Notes

Return type

(empty response body)

Authorization

api_key, basic_auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]