Jump to

• Request
• Response

Retrieve DataObject's Metadata

get

/ic/api/process/v1/analyticsdataobjects/{dataObjectName}

Retrieve DataObject's metadata details

Request

Path Parameters

• dataObjectName(required): string
  dataObject name

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : DataObjectMetadata

Type: object

Show Source

• columns: array columns
• displayName: string
• links: array links
• name: string

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "columns":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Column"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "xml":{
        "name":"DataObjectMetadata",
        "namespace":"http://xmlns.oracle.com/bpm/rest/DataObjectMetadata"
    }
}

Nested Schema : columns

Type: array

Show Source

• Array of: object Column

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

Nested Schema : links

Type: array

Show Source

• Array of: object Link

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

Nested Schema : Column

Type: object

Show Source

• dataType: string
  Allowed Values: [ "STRING", "INTEGER", "DECIMAL", "BOOLEAN", "TIME" ]
• entityAttributes: array entityAttributes
• key: boolean
• name: string
• size: integer(int32)
• transientAttributes: object transientAttributes
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "properties":{
        "dataType":{
            "type":"string",
            "enum":[
                "STRING",
                "INTEGER",
                "DECIMAL",
                "BOOLEAN",
                "TIME"
            ]
        },
        "key":{
            "type":"boolean"
        },
        "name":{
            "type":"string"
        },
        "size":{
            "type":"integer",
            "format":"int32"
        },
        "transientAttributes":{
            "type":"object",
            "additionalProperties":{
                "type":"object"
            }
        },
        "entityAttributes":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/AttrObject"
            }
        }
    }
}

Nested Schema : entityAttributes

Type: array

Show Source

• Array of: object AttrObject

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

Nested Schema : transientAttributes

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object"
    }
}

Nested Schema : AttrObject

Type: object

Show Source

• attrType: string
  Allowed Values: [ "VALUE", "REF" ]
• contentType: string
  Allowed Values: [ "OBJECT", "NATIVE_OBJECT", "LIST", "SORTED_LIST", "MAP" ]
• defaultValue: object defaultValue
• id: string
• msg: object Msg

{
    "type":"object",
    "properties":{
        "msg":{
            "$ref":"#/definitions/Msg"
        },
        "attrType":{
            "type":"string",
            "enum":[
                "VALUE",
                "REF"
            ]
        },
        "contentType":{
            "type":"string",
            "enum":[
                "OBJECT",
                "NATIVE_OBJECT",
                "LIST",
                "SORTED_LIST",
                "MAP"
            ]
        },
        "id":{
            "type":"string"
        },
        "defaultValue":{
            "type":"object"
        }
    }
}

Nested Schema : defaultValue

Type: object

Nested Schema : Msg

Type: object

Show Source

• allAvailableTranslationsForProjectLanguages: object allAvailableTranslationsForProjectLanguages
  Additional Properties Allowed: additionalProperties
• argCount: integer(int32)
• bundleName: string
• bundleShortName: string
• code: string
• detail: string
• imageFile: string
• imageResource: string(url)
• localizedLogMessage: string
• logComponent: string
  Allowed Values: [ "DEFAULT" ]
• mnemonic: string
• nonLocalizedString: string
• string: string

{
    "type":"object",
    "properties":{
        "code":{
            "type":"string"
        },
        "logComponent":{
            "type":"string",
            "enum":[
                "DEFAULT"
            ]
        },
        "argCount":{
            "type":"integer",
            "format":"int32"
        },
        "string":{
            "type":"string"
        },
        "detail":{
            "type":"string"
        },
        "allAvailableTranslationsForProjectLanguages":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            }
        },
        "mnemonic":{
            "type":"string"
        },
        "localizedLogMessage":{
            "type":"string"
        },
        "imageFile":{
            "type":"string"
        },
        "imageResource":{
            "type":"string",
            "format":"url"
        },
        "nonLocalizedString":{
            "type":"string"
        },
        "bundleShortName":{
            "type":"string"
        },
        "bundleName":{
            "type":"string"
        }
    }
}

Nested Schema : allAvailableTranslationsForProjectLanguages

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Nested Schema : Link

Type: object

Show Source

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400 Response

Bad request

401 Response

Unauthorized

404 Response

No metadata found

500 Response

Internal Server Error

Back to Top