Skip to content

Latest commit

 

History

History
165 lines (99 loc) · 5.38 KB

ImportSettingsApi.md

File metadata and controls

165 lines (99 loc) · 5.38 KB

\ImportSettingsApi

All URIs are relative to https://cloud.memsource.com/web

Method HTTP request Description
CreateImportSettings Post /api2/v1/importSettings Create import settings
DeleteImportSettings Delete /api2/v1/importSettings/{uid} Delete import settings
GetImportSettings Get /api2/v1/importSettings/{uid} Get import settings
GetImportSettings1 Get /api2/v1/importSettings/default Get organization's default import settings
ListImportSettings Get /api2/v1/importSettings List import settings

CreateImportSettings

ImportSettingsDto CreateImportSettings(ctx, optional) Create import settings

Pre-defined import settings is handy for Create Job. See supported file types

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ImportSettingsApiCreateImportSettingsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportSettingsApiCreateImportSettingsOpts struct

Name Type Description Notes
body optional.Interface of ImportSettingsCreateDto

Return type

ImportSettingsDto

Authorization

No authorization required

HTTP request headers

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

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

DeleteImportSettings

DeleteImportSettings(ctx, uid) Delete import settings

Required Parameters

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

Return type

(empty response body)

Authorization

No authorization required

HTTP request headers

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

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

GetImportSettings

ImportSettingsDto GetImportSettings(ctx, uid) Get import settings

Required Parameters

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

Return type

ImportSettingsDto

Authorization

No authorization required

HTTP request headers

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

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

GetImportSettings1

ImportSettingsDto GetImportSettings1(ctx, ) Get organization's default import settings

Required Parameters

This endpoint does not need any parameter.

Return type

ImportSettingsDto

Authorization

No authorization required

HTTP request headers

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

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

ListImportSettings

PageDtoImportSettingsReference ListImportSettings(ctx, optional) List import settings

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *ImportSettingsApiListImportSettingsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a ImportSettingsApiListImportSettingsOpts struct

Name Type Description Notes
name optional.String
pageNumber optional.Int32 Page number, starting with 0, default 0 [default to 0]
pageSize optional.Int32 Page size, accepts values between 1 and 50, default 50 [default to 50]

Return type

PageDtoImportSettingsReference

Authorization

No authorization required

HTTP request headers

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

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