Skip to content

Latest commit

 

History

History
491 lines (319 loc) · 13.7 KB

IndustryAPI.md

File metadata and controls

491 lines (319 loc) · 13.7 KB

\IndustryAPI

All URIs are relative to https://yasm.prodyna.com:443/api/v1

Method HTTP request Description
AttachOrganizationToIndustry Post /organizations/{organizationId}/industries/{industryId} Add an Organization to an Industry
CreateIndustry Post /industries Create an Industry
DeleteIndustry Delete /industries/{industryId} Delete an Industry
DetachOrganizationFromIndustry Delete /organizations/{organizationId}/industries/{industryId} Remove an Organization to an Industry
GetIndustry Get /industries/{industryId} Get details about an Industry
SearchIndustries Post /industries/search Search over industries
UpdateIndustry Put /industries/{industryId} Update an Industry

AttachOrganizationToIndustry

OrganizationDetails AttachOrganizationToIndustry(ctx, organizationId, industryId).Execute()

Add an Organization to an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    industryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.AttachOrganizationToIndustry(context.Background(), organizationId, industryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.AttachOrganizationToIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `AttachOrganizationToIndustry`: OrganizationDetails
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.AttachOrganizationToIndustry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string
industryId string

Other Parameters

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

Name Type Description Notes

Return type

OrganizationDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

CreateIndustry

IndustryDetails CreateIndustry(ctx).Industry(industry).Execute()

Create an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    industry := *openapiclient.NewIndustry("Id_example", "Name_example") // Industry | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.CreateIndustry(context.Background()).Industry(industry).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.CreateIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `CreateIndustry`: IndustryDetails
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.CreateIndustry`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
industry Industry

Return type

IndustryDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

DeleteIndustry

Status DeleteIndustry(ctx, industryId).Execute()

Delete an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    industryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.DeleteIndustry(context.Background(), industryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.DeleteIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DeleteIndustry`: Status
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.DeleteIndustry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
industryId string

Other Parameters

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

Name Type Description Notes

Return type

Status

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

DetachOrganizationFromIndustry

OrganizationDetails DetachOrganizationFromIndustry(ctx, organizationId, industryId).Execute()

Remove an Organization to an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    organizationId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    industryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.DetachOrganizationFromIndustry(context.Background(), organizationId, industryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.DetachOrganizationFromIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `DetachOrganizationFromIndustry`: OrganizationDetails
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.DetachOrganizationFromIndustry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
organizationId string
industryId string

Other Parameters

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

Name Type Description Notes

Return type

OrganizationDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

GetIndustry

IndustryDetails GetIndustry(ctx, industryId).Execute()

Get details about an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    industryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.GetIndustry(context.Background(), industryId).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.GetIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `GetIndustry`: IndustryDetails
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.GetIndustry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
industryId string

Other Parameters

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

Name Type Description Notes

Return type

IndustryDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

SearchIndustries

PagedIndustries SearchIndustries(ctx).IndustrySearch(industrySearch).Execute()

Search over industries

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    industrySearch := *openapiclient.NewIndustrySearch(int32(123), int32(123)) // IndustrySearch |  (optional)

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.SearchIndustries(context.Background()).IndustrySearch(industrySearch).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.SearchIndustries``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `SearchIndustries`: PagedIndustries
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.SearchIndustries`: %v\n", resp)
}

Path Parameters

Other Parameters

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

Name Type Description Notes
industrySearch IndustrySearch

Return type

PagedIndustries

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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

UpdateIndustry

IndustryDetails UpdateIndustry(ctx, industryId).Industry(industry).Execute()

Update an Industry

Example

package main

import (
    "context"
    "fmt"
    "os"
    openapiclient "github.com/prodyna-yasm/yasm-api-go"
)

func main() {
    industryId := "38400000-8cf0-11bd-b23e-10b96e4ef00d" // string | 
    industry := *openapiclient.NewIndustry("Id_example", "Name_example") // Industry | 

    configuration := openapiclient.NewConfiguration()
    apiClient := openapiclient.NewAPIClient(configuration)
    resp, r, err := apiClient.IndustryAPI.UpdateIndustry(context.Background(), industryId).Industry(industry).Execute()
    if err != nil {
        fmt.Fprintf(os.Stderr, "Error when calling `IndustryAPI.UpdateIndustry``: %v\n", err)
        fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
    }
    // response from `UpdateIndustry`: IndustryDetails
    fmt.Fprintf(os.Stdout, "Response from `IndustryAPI.UpdateIndustry`: %v\n", resp)
}

Path Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
industryId string

Other Parameters

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

Name Type Description Notes

industry | Industry | |

Return type

IndustryDetails

Authorization

oidcScheme, bearerScheme

HTTP request headers

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

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