Skip to content

Latest commit

 

History

History
359 lines (234 loc) · 14.3 KB

FilterApi.md

File metadata and controls

359 lines (234 loc) · 14.3 KB
Raw

{{classname}}

All URIs are relative to https://app.harness.io/gateway

Method HTTP request Description
DeleteFilter Delete /ng/api/filters/{identifier} Delete a Filter by identifier
GetConnectorListV21 Get /ng/api/filters Get the list of Filters satisfying the criteria (if any) in the request
GetFilter Get /ng/api/filters/{identifier} Gets a Filter by identifier
PipelinedeleteFilter Delete /pipeline/api/filters/{identifier} Delete a Filter by identifier
PipelinegetConnectorListV2 Get /pipeline/api/filters Get the list of Filters satisfying the criteria (if any) in the request
PipelinegetFilter Get /pipeline/api/filters/{identifier} Gets a Filter by identifier
PipelinepostFilter Post /pipeline/api/filters Creates a Filter
PipelineupdateFilter Put /pipeline/api/filters Updates the Filter
PostFilter Post /ng/api/filters Creates a Filter
UpdateFilter Put /ng/api/filters Updates the Filter

DeleteFilter

ResponseDtoBoolean DeleteFilter(ctx, accountIdentifier, identifier, type_, optional) Delete a Filter by identifier

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the Entity
identifier string Filter Identifier
type_ string Type of Filter
optional *FilterApiDeleteFilterOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiDeleteFilterOpts struct

Name Type Description Notes

orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |

Return type

ResponseDtoBoolean

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

GetConnectorListV21

ResponseDtoPageResponseFilter GetConnectorListV21(ctx, accountIdentifier, type_, optional) Get the list of Filters satisfying the criteria (if any) in the request

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the Entity
type_ string Type of Filter
optional *FilterApiGetConnectorListV21Opts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiGetConnectorListV21Opts struct

Name Type Description Notes

pageIndex | optional.Int32| Page number of navigation. If left empty, default value of 0 is assumed | [default to 0] pageSize | optional.Int32| Number of entries per page. If left empty, default value of 100 is assumed | [default to 100] orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |

Return type

ResponseDtoPageResponseFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

GetFilter

ResponseDtoFilter GetFilter(ctx, accountIdentifier, identifier, type_, optional) Gets a Filter by identifier

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the Entity
identifier string Filter Identifier
type_ string Type of Filter
optional *FilterApiGetFilterOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiGetFilterOpts struct

Name Type Description Notes

orgIdentifier | optional.String| Organization Identifier for the Entity | projectIdentifier | optional.String| Project Identifier for the Entity |

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PipelinedeleteFilter

ResponseDtoBoolean PipelinedeleteFilter(ctx, accountIdentifier, identifier, type_, optional) Delete a Filter by identifier

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the entity
identifier string Filter Identifier
type_ string Type of Filter
optional *FilterApiPipelinedeleteFilterOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiPipelinedeleteFilterOpts struct

Name Type Description Notes

orgIdentifier | optional.String| Organization Identifier for the entity | projectIdentifier | optional.String| Project Identifier for the entity |

Return type

ResponseDtoBoolean

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PipelinegetConnectorListV2

ResponseDtoPageResponseFilter PipelinegetConnectorListV2(ctx, accountIdentifier, type_, optional) Get the list of Filters satisfying the criteria (if any) in the request

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the entity
type_ string Type of Filter
optional *FilterApiPipelinegetConnectorListV2Opts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiPipelinegetConnectorListV2Opts struct

Name Type Description Notes

pageIndex | optional.Int32| Page number of navigation. If left empty, default value of 0 is assumed | [default to 0] pageSize | optional.Int32| Number of entries per page. If left empty, default value of 100 is assumed | [default to 100] orgIdentifier | optional.String| Organization Identifier for the entity | projectIdentifier | optional.String| Project Identifier for the entity |

Return type

ResponseDtoPageResponseFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PipelinegetFilter

ResponseDtoFilter PipelinegetFilter(ctx, accountIdentifier, identifier, type_, optional) Gets a Filter by identifier

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
accountIdentifier string Account Identifier for the entity
identifier string Filter Identifier
type_ string Type of Filter
optional *FilterApiPipelinegetFilterOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a FilterApiPipelinegetFilterOpts struct

Name Type Description Notes

orgIdentifier | optional.String| Organization Identifier for the entity | projectIdentifier | optional.String| Project Identifier for the entity |

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PipelinepostFilter

ResponseDtoFilter PipelinepostFilter(ctx, body, accountIdentifier) Creates a Filter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Filter Details of the Connector to create
accountIdentifier string Account Identifier for the entity

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, text/yaml, text/html, text/plain
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PipelineupdateFilter

ResponseDtoFilter PipelineupdateFilter(ctx, body, accountIdentifier) Updates the Filter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Filter This is the updated Filter. This should have all the fields not just the updated ones
accountIdentifier string Account Identifier for the entity

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, text/yaml, text/html, text/plain
  • Accept: application/json, application/yaml, text/yaml, text/html

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

PostFilter

ResponseDtoFilter PostFilter(ctx, body, accountIdentifier) Creates a Filter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Filter Details of the Connector to create
accountIdentifier string Account Identifier for the Entity

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, text/yaml, text/html, text/plain
  • Accept: application/json, application/yaml, text/yaml, text/html

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

UpdateFilter

ResponseDtoFilter UpdateFilter(ctx, body, accountIdentifier) Updates the Filter

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
body Filter This is the updated Filter. This should have all the fields not just the updated ones
accountIdentifier string Account Identifier for the Entity

Return type

ResponseDtoFilter

Authorization

ApiKey

HTTP request headers

  • Content-Type: application/json, text/yaml, text/html, text/plain
  • Accept: application/json, application/yaml, text/yaml, text/html

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