Skip to content

Latest commit

 

History

History
555 lines (340 loc) · 14.8 KB

StockroomsApi.md

File metadata and controls

555 lines (340 loc) · 14.8 KB

\StockroomsApi

All URIs are relative to http://localhost

Method HTTP request Description
ApiV3StockroomsGet Get /api/v3/stockrooms
ApiV3StockroomsIdentChangesHistoryGet Get /api/v3/stockrooms/{ident}/changes-history
ApiV3StockroomsIdentDelete Delete /api/v3/stockrooms/{ident}
ApiV3StockroomsIdentGet Get /api/v3/stockrooms/{ident}
ApiV3StockroomsIdentPatch Patch /api/v3/stockrooms/{ident}
ApiV3StockroomsPost Post /api/v3/stockrooms
ApiV3StockroomsSavedsearchesGet Get /api/v3/stockrooms/savedsearches
ApiV3StockroomsSavedsearchesIdentGet Get /api/v3/stockrooms/savedsearches/{ident}

ApiV3StockroomsGet

ApiV3StockroomsGet(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.StockroomsApi.ApiV3StockroomsGet(context.Background()).Limit(limit).Skip(skip).Sortby(sortby).Filter(filter).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsGet``: %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 apiApiV3StockroomsGetRequest 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]

ApiV3StockroomsIdentChangesHistoryGet

ApiV3StockroomsIdentChangesHistoryGet(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.StockroomsApi.ApiV3StockroomsIdentChangesHistoryGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsIdentChangesHistoryGet``: %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 apiApiV3StockroomsIdentChangesHistoryGetRequest 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]

ApiV3StockroomsIdentDelete

ApiV3StockroomsIdentDelete(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.StockroomsApi.ApiV3StockroomsIdentDelete(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsIdentDelete``: %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 apiApiV3StockroomsIdentDeleteRequest 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]

ApiV3StockroomsIdentGet

ApiV3StockroomsIdentGet(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.StockroomsApi.ApiV3StockroomsIdentGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsIdentGet``: %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 apiApiV3StockroomsIdentGetRequest 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]

ApiV3StockroomsIdentPatch

ApiV3StockroomsIdentPatch(ctx, ident).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Stockroom(stockroom).Execute()

Example

package main

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

func main() {
    ident := "ident_example" // string | ID of system object (assets, locations, ...)
    oomnitzaIgnoreMetaRestriction := "oomnitzaIgnoreMetaRestriction_example" // string | Used to allow the non-system edit-only field to be updated. Allowed values: 0, 1 (optional)
    stockroom := *openapiclient.NewStockroom() // Stockroom |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.StockroomsApi.ApiV3StockroomsIdentPatch(context.Background(), ident).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Stockroom(stockroom).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsIdentPatch``: %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 apiApiV3StockroomsIdentPatchRequest 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 | stockroom | Stockroom | |

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]

ApiV3StockroomsPost

ApiV3StockroomsPost(ctx).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Stockroom(stockroom).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)
    stockroom := *openapiclient.NewStockroom() // Stockroom |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.StockroomsApi.ApiV3StockroomsPost(context.Background()).OomnitzaIgnoreMetaRestriction(oomnitzaIgnoreMetaRestriction).Stockroom(stockroom).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsPost``: %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 apiApiV3StockroomsPostRequest 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
stockroom Stockroom

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]

ApiV3StockroomsSavedsearchesGet

ApiV3StockroomsSavedsearchesGet(ctx).Execute()

Example

package main

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

func main() {

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.StockroomsApi.ApiV3StockroomsSavedsearchesGet(context.Background()).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsSavedsearchesGet``: %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 apiApiV3StockroomsSavedsearchesGetRequest 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]

ApiV3StockroomsSavedsearchesIdentGet

ApiV3StockroomsSavedsearchesIdentGet(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.StockroomsApi.ApiV3StockroomsSavedsearchesIdentGet(context.Background(), ident).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `StockroomsApi.ApiV3StockroomsSavedsearchesIdentGet``: %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 apiApiV3StockroomsSavedsearchesIdentGetRequest 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]