Jump to

• Request
• Response

Unpublish a GGSA pipeline

patch

https://{ggsa_host}:{ggsa_port}/{context_path}/services/{version}/pipelines/{id}/unpublish

Unpublish a GGSA pipeline

Request

Path Parameters

• id(required): string
  Pipeline id
• version(required): string
  GGSA API version

  Example:

  v1

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully unpublished the pipeline.

Body ()

Root Schema : PipelineDetail

Type: object

Show Source

• createdAt: string (date-time)
  Creation time of GGSA Pipeline.
• createdBy: string
  Author of the GGSA Pipeline.
• description: string
  GGSA Pipeline Description.
• displayName: string
  GGSA Pipeline Display Name.
• id: string
  GGSA Pipeline ID.
• name: string
  GGSA Pipeline Name.
• published: boolean
  GGSA Pipeline Publish Flag.
• tagNames: array tagnames
  List of tags defined for the GGSA Pipeline.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"GGSA Pipeline ID."
        },
        "name":{
            "type":"string",
            "description":"GGSA Pipeline Name."
        },
        "displayName":{
            "type":"string",
            "description":"GGSA Pipeline Display Name."
        },
        "description":{
            "type":"string",
            "description":"GGSA Pipeline Description."
        },
        "tagNames":{
            "type":"array",
            "description":"List of tags defined for the GGSA Pipeline.",
            "xml":{
                "name":"tagnames"
            },
            "items":{
                "type":"string",
                "description":"List of tags defined for the GGSA Pipeline.",
                "xml":{
                    "name":"tagnames"
                }
            }
        },
        "createdBy":{
            "type":"string",
            "description":"Author of the GGSA Pipeline."
        },
        "createdAt":{
            "type":"string",
            "description":"Creation time of GGSA Pipeline.",
            "format":"date-time"
        },
        "published":{
            "type":"boolean",
            "description":"GGSA Pipeline Publish Flag."
        }
    },
    "xml":{
        "name":"PipelineDetail"
    }
}

Nested Schema : tagnames

Type: array

List of tags defined for the GGSA Pipeline.

Show Source

• Array of: string
  List of tags defined for the GGSA Pipeline.

{
    "type":"array",
    "description":"List of tags defined for the GGSA Pipeline.",
    "xml":{
        "name":"tagnames"
    },
    "items":{
        "type":"string",
        "description":"List of tags defined for the GGSA Pipeline.",
        "xml":{
            "name":"tagnames"
        }
    }
}

404 Response

pipeline id not found

409 Response

Incorrect state / conflict.

Back to Top