Jump to

• Request
• Response
• Examples

Import Library Metadata

post

/ic/api/integration/v1/libraries/{id}/metadata

Imports the metadata XML file for the library with the specified ID. If you are using cURL, use the -F option to specify the file to import.

Request

Supported Media Types

• multipart/form-data

Path Parameters

• id: string
  Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).

Form Parameters

• file: file
  Library metadata file content

Back to Top

Response

Supported Media Types

• application/json; charset=utf-8

200 Response

Successful operation

Body ()

Root Schema : api-library

Type: object

Show Source

• allApis(optional): array allApis
• code(optional): string
• description(optional): string
• files(optional): array source
• filterByConfigType(optional): string
• functionsSize(optional): integer(int32)
• implFiles(optional): array implFiles
• implType(optional): string
  Allowed Values: [ "JAVASCRIPT", "JAVA" ]
• kids(optional): array kids
• name(optional): string
• searchByName(optional): string
• selectedFile(optional): object APILibraryFile
• type(optional): string
• version(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "code":{
            "type":"string"
        },
        "version":{
            "type":"string"
        },
        "selectedFile":{
            "$ref":"#/definitions/APILibraryFile"
        },
        "description":{
            "type":"string"
        },
        "implType":{
            "type":"string",
            "xml":{
                "name":"implementationType"
            },
            "enum":[
                "JAVASCRIPT",
                "JAVA"
            ]
        },
        "implFiles":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/File"
            }
        },
        "files":{
            "type":"array",
            "xml":{
                "name":"source",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/APILibraryFile"
            }
        },
        "kids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/INode"
            }
        },
        "searchByName":{
            "type":"string"
        },
        "functionsSize":{
            "type":"integer",
            "format":"int32"
        },
        "filterByConfigType":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "allApis":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/API"
            }
        }
    },
    "xml":{
        "name":"api-library"
    }
}

Nested Schema : allApis

Type: array

Show Source

• Array of: object API

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/API"
    }
}

Nested Schema : source

Type: array

Show Source

• Array of: object APILibraryFile

{
    "type":"array",
    "xml":{
        "name":"source",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/APILibraryFile"
    }
}

Nested Schema : implFiles

Type: array

Show Source

• Array of: object File

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/File"
    }
}

Nested Schema : kids

Type: array

Show Source

• Array of: object INode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/INode"
    }
}

Nested Schema : APILibraryFile

Type: object

Show Source

• apiCount(optional): integer(int32)
• apiIdList(optional): array apiIdList
  Unique Items Required: true
• currentFunc(optional): string
• duplicateFunctionsChecked(optional): boolean
  Default Value: false
• fileName(optional): string
• filterByConfigType(optional): string
• functionConfigured(optional): boolean
  Default Value: false
• functionList(optional): array functionList
  Unique Items Required: true
• functions(optional): array api
• kids(optional): array kids
• lastFunc(optional): object API
• libraryCode(optional): string
• libraryName(optional): string
• libraryVersion(optional): string
• name(optional): string
• path(optional): string
• searchByName(optional): string
• selectedFileName(optional): string
• selectedFunction(optional): object API
• type(optional): string

{
    "type":"object",
    "properties":{
        "fileName":{
            "type":"string"
        },
        "path":{
            "type":"string"
        },
        "apiIdList":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "functions":{
            "type":"array",
            "xml":{
                "name":"api",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/API"
            }
        },
        "kids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/INode"
            }
        },
        "currentFunc":{
            "type":"string"
        },
        "libraryName":{
            "type":"string"
        },
        "libraryCode":{
            "type":"string"
        },
        "libraryVersion":{
            "type":"string"
        },
        "lastFunc":{
            "$ref":"#/definitions/API"
        },
        "searchByName":{
            "type":"string"
        },
        "filterByConfigType":{
            "type":"string"
        },
        "functionConfigured":{
            "type":"boolean",
            "default":false
        },
        "selectedFileName":{
            "type":"string"
        },
        "selectedFunction":{
            "$ref":"#/definitions/API"
        },
        "functionList":{
            "type":"array",
            "uniqueItems":true,
            "items":{
                "type":"string"
            }
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "apiCount":{
            "type":"integer",
            "format":"int32"
        },
        "duplicateFunctionsChecked":{
            "type":"boolean",
            "default":false
        }
    }
}

Nested Schema : API

Type: object

Show Source

• annotationSet(optional): boolean
  Default Value: false
• apiId(optional): string
• classification(optional): string
  Allowed Values: [ "ADAPTER", "ORCHESTRATION", "XPATH" ]
• classified(optional): boolean
  Default Value: false
• configured(optional): boolean
  Default Value: false
• duplicateFnFlag(optional): boolean
  Default Value: false
• fileName(optional): string
• funcAnnotation(optional): string
• funcName(optional): string
• inputCompleted(optional): boolean
  Default Value: false
• inputs(optional): array input
• kids(optional): array kids
• libraryCode(optional): string
• libraryName(optional): string
• libraryVersion(optional): string
• multipleClassification(optional): array classification
• name(optional): string
• orchestrationClassified(optional): boolean
  Default Value: false
• outputCompleted(optional): boolean
  Default Value: false
• outputs(optional): array output
• parent(optional): object API
• status(optional): string
• type(optional): string
• unsupportedSyntax(optional): boolean
  Default Value: false
• unsupportedSyntaxType(optional): string
• xpathClassified(optional): boolean
  Default Value: false

{
    "type":"object",
    "properties":{
        "funcName":{
            "type":"string",
            "xml":{
                "name":"name"
            }
        },
        "apiId":{
            "type":"string",
            "xml":{
                "name":"apiid",
                "attribute":true
            }
        },
        "duplicateFnFlag":{
            "type":"boolean",
            "default":false
        },
        "classification":{
            "type":"string",
            "enum":[
                "ADAPTER",
                "ORCHESTRATION",
                "XPATH"
            ]
        },
        "libraryName":{
            "type":"string"
        },
        "libraryCode":{
            "type":"string"
        },
        "libraryVersion":{
            "type":"string"
        },
        "status":{
            "type":"string"
        },
        "fileName":{
            "type":"string"
        },
        "funcAnnotation":{
            "type":"string",
            "xml":{
                "name":"annotation"
            }
        },
        "inputs":{
            "type":"array",
            "xml":{
                "name":"input",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/APIParam"
            }
        },
        "outputs":{
            "type":"array",
            "xml":{
                "name":"output",
                "wrapped":true
            },
            "items":{
                "$ref":"#/definitions/APIParam"
            }
        },
        "unsupportedSyntax":{
            "type":"boolean",
            "default":false
        },
        "unsupportedSyntaxType":{
            "type":"string"
        },
        "parent":{
            "$ref":"#/definitions/API"
        },
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "multipleClassification":{
            "type":"array",
            "xml":{
                "name":"classification"
            },
            "items":{
                "type":"string",
                "enum":[
                    "ADAPTER",
                    "ORCHESTRATION",
                    "XPATH"
                ]
            }
        },
        "configured":{
            "type":"boolean",
            "default":false
        },
        "classified":{
            "type":"boolean",
            "default":false
        },
        "orchestrationClassified":{
            "type":"boolean",
            "default":false
        },
        "xpathClassified":{
            "type":"boolean",
            "default":false
        },
        "inputCompleted":{
            "type":"boolean",
            "default":false
        },
        "outputCompleted":{
            "type":"boolean",
            "default":false
        },
        "annotationSet":{
            "type":"boolean",
            "default":false
        },
        "kids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/INode"
            }
        }
    }
}

Nested Schema : input

Type: array

Show Source

• Array of: object APIParam

{
    "type":"array",
    "xml":{
        "name":"input",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/APIParam"
    }
}

Nested Schema : kids

Type: array

Show Source

• Array of: object INode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/INode"
    }
}

Nested Schema : classification

Type: array

Show Source

• Array of: string
  Allowed Values: [ "ADAPTER", "ORCHESTRATION", "XPATH" ]

{
    "type":"array",
    "xml":{
        "name":"classification"
    },
    "items":{
        "type":"string",
        "enum":[
            "ADAPTER",
            "ORCHESTRATION",
            "XPATH"
        ]
    }
}

Nested Schema : output

Type: array

Show Source

• Array of: object APIParam

{
    "type":"array",
    "xml":{
        "name":"output",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/APIParam"
    }
}

Nested Schema : APIParam

Type: object

Show Source

• desc(optional): string
• described(optional): string
• icon(optional): string
• name(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "desc":{
            "type":"string",
            "xml":{
                "name":"description"
            }
        },
        "described":{
            "type":"string"
        },
        "icon":{
            "type":"string"
        }
    }
}

Nested Schema : INode

Type: object

Show Source

• kids(optional): array kids
• name(optional): string
• type(optional): string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "type":{
            "type":"string"
        },
        "kids":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/INode"
            }
        }
    }
}

Nested Schema : kids

Type: array

Show Source

• Array of: object INode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/INode"
    }
}

Nested Schema : File

Type: object

Show Source

• absolute(optional): boolean
  Default Value: false
• absoluteFile(optional): object File
• absolutePath(optional): string
• canonicalFile(optional): object File
• canonicalPath(optional): string
• directory(optional): boolean
  Default Value: false
• file(optional): boolean
  Default Value: false
• freeSpace(optional): integer(int64)
• hidden(optional): boolean
  Default Value: false
• name(optional): string
• parent(optional): string
• parentFile(optional): object File
• path(optional): string
• totalSpace(optional): integer(int64)
• usableSpace(optional): integer(int64)

{
    "type":"object",
    "properties":{
        "path":{
            "type":"string"
        },
        "name":{
            "type":"string"
        },
        "parent":{
            "type":"string"
        },
        "absolute":{
            "type":"boolean",
            "default":false
        },
        "canonicalPath":{
            "type":"string"
        },
        "parentFile":{
            "$ref":"#/definitions/File"
        },
        "absolutePath":{
            "type":"string"
        },
        "absoluteFile":{
            "$ref":"#/definitions/File"
        },
        "canonicalFile":{
            "$ref":"#/definitions/File"
        },
        "directory":{
            "type":"boolean",
            "default":false
        },
        "file":{
            "type":"boolean",
            "default":false
        },
        "hidden":{
            "type":"boolean",
            "default":false
        },
        "totalSpace":{
            "type":"integer",
            "format":"int64"
        },
        "freeSpace":{
            "type":"integer",
            "format":"int64"
        },
        "usableSpace":{
            "type":"integer",
            "format":"int64"
        }
    }
}

Nested Schema : apiIdList

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : functionList

Type: array

Unique Items Required: true

Show Source

• Array of: string

{
    "type":"array",
    "uniqueItems":true,
    "items":{
        "type":"string"
    }
}

Nested Schema : api

Type: array

Show Source

• Array of: object API

{
    "type":"array",
    "xml":{
        "name":"api",
        "wrapped":true
    },
    "items":{
        "$ref":"#/definitions/API"
    }
}

Nested Schema : kids

Type: array

Show Source

• Array of: object INode

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/INode"
    }
}

400 Response

Bad request, missing required data

404 Response

Library not found

500 Response

Server error

Back to Top

Examples

The following example shows how to import the JavaScript library metadata XML file by submitting a POST request on the REST resource using cURL. For more information about cURL, see Use cURL. For more information about endpoint URL structure, see Send Requests.

Example: Import metadata for the library JSLIB|01.00.0000

The id is in the form: code%7Cversion. The %7C is the encoded | (vertical line).

curl -X POST -H 'Authorization: Bearer access_token' -H "Content-Type:multipart/form-data" -F "file=@JSFILE_01.00.0000.xml" https://integration.us.oraclecloud.com/ic/api/integration/v1/libraries/JSLIB%7C01.00.0000/metadata

Back to Top