Jump to

• Request
• Response

Import GGSA artifacts

patch

https://{ggsa_host}:{ggsa_port}/{context_path}/services/{version}/artifacts/import

Import GGSA artifacts from the bundle(archive).

Request

Path Parameters

• version(required): string
  GGSA API version

  Example:

  v1

Query Parameters

• overwrite(required): boolean
  if true, Overwrite the existing artifact with the new one matched in the bundle otherwise ignore all such artifact in the bundle.

  Example:

  true

Supported Media Types

• multipart/form-data

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successfully imported the artifacts.

Body ()

Root Schema : Artifact

Type: object

Show Source

• createdAt: string (date-time)
  Creation time of GGSA Artifact.
• createdBy: string
  Author of the GGSA Artifact.
• description: string
  GGSA Artifact Description.
• id: string
  GGSA Artifact ID.
• name: string
  GGSA Artifact Name.
• tagNames: array tagNames
  Unique Items Required: true

  List of tags defined for the GGSA Artifact.
• type: string
  GGSA Artifact Type.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"GGSA Artifact ID."
        },
        "name":{
            "type":"string",
            "description":"GGSA Artifact Name."
        },
        "description":{
            "type":"string",
            "description":"GGSA Artifact Description."
        },
        "type":{
            "type":"string",
            "description":"GGSA Artifact Type."
        },
        "createdBy":{
            "type":"string",
            "description":"Author of the GGSA Artifact."
        },
        "createdAt":{
            "type":"string",
            "description":"Creation time of GGSA Artifact.",
            "format":"date-time"
        },
        "tagNames":{
            "uniqueItems":true,
            "type":"array",
            "description":"List of tags defined for the GGSA Artifact.",
            "items":{
                "type":"string",
                "description":"List of tags defined for the GGSA Artifact.",
                "xml":{
                    "name":"tagNames"
                }
            }
        }
    },
    "xml":{
        "name":"Artifact"
    }
}

Nested Schema : tagNames

Type: array

Unique Items Required: true

List of tags defined for the GGSA Artifact.

Show Source

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

{
    "uniqueItems":true,
    "type":"array",
    "description":"List of tags defined for the GGSA Artifact.",
    "items":{
        "type":"string",
        "description":"List of tags defined for the GGSA Artifact.",
        "xml":{
            "name":"tagNames"
        }
    }
}

404 Response

Entity not found.

409 Response

Incorrect state / conflict.

Back to Top