Jump to

• Request
• Response

Method to update existing artifacts

put

/mftapp/rest/v1/artifacts

Request

Supported Media Types

• multipart/form-data

Query Parameters

• previewModeFlag(optional): boolean
  Value depicts if preview mode is true or false

Body ()

A body of type:

• multipart/form-data

Root Schema : schema

Response

Supported Media Types

• application/json

200 Response

Body ()

Root Schema : MFT Artifacts result

Type: object

Title: MFT Artifacts result

Show Source

• failureResults(optional): array failureResults
• successResults(optional): array successResults

{
    "title":"MFT Artifacts result",
    "type":"object",
    "properties":{
        "successResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"",
                        "type":"string"
                    },
                    "id":{
                        "description":"",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"",
                        "type":"string"
                    }
                }
            }
        },
        "failureResults":{
            "description":"",
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "artifactName":{
                        "description":"",
                        "type":"string"
                    },
                    "artifactCategory":{
                        "description":"",
                        "type":"string"
                    },
                    "errorMessage":{
                        "description":"",
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : failureResults

Type: array

Show Source

• [0]: object items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "artifactName":{
                "description":"",
                "type":"string"
            },
            "artifactCategory":{
                "description":"",
                "type":"string"
            },
            "errorMessage":{
                "description":"",
                "type":"string"
            }
        }
    }
}

Nested Schema : successResults

Type: array

Show Source

• [0]: object items

{
    "description":"",
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "artifactName":{
                "description":"",
                "type":"string"
            },
            "id":{
                "description":"",
                "type":"string"
            },
            "artifactCategory":{
                "description":"",
                "type":"string"
            },
            "errorMessage":{
                "description":"",
                "type":"string"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
• artifactName(optional): string
• errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "artifactName":{
            "description":"",
            "type":"string"
        },
        "artifactCategory":{
            "description":"",
            "type":"string"
        },
        "errorMessage":{
            "description":"",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• artifactCategory(optional): string
• artifactName(optional): string
• errorMessage(optional): string
• id(optional): string

{
    "type":"object",
    "properties":{
        "artifactName":{
            "description":"",
            "type":"string"
        },
        "id":{
            "description":"",
            "type":"string"
        },
        "artifactCategory":{
            "description":"",
            "type":"string"
        },
        "errorMessage":{
            "description":"",
            "type":"string"
        }
    }
}

500 Response

Body ()

Root Schema : schema

Type: object

Show Source

• errorCode(optional): string
• errorKey(optional): string
• errorMessage(optional): string

{
    "type":"object",
    "properties":{
        "errorCode":{
            "type":"string",
            "description":""
        },
        "errorKey":{
            "type":"string",
            "description":""
        },
        "errorMessage":{
            "type":"string",
            "description":""
        }
    }
}

Example Response (application/json)

{
    "errorCode":"MFT-7439",
    "errorKey":"MFT_UTILITY_COULD_NOT_QUERY_MDS_ARTIFACT_ID_BY_NAME",
    "errorMessage":"Unable to find artifact by artifact name src1"
}