Jump to

• Request
• Response
• Examples

Get All Intelligence Model Trainings

get

/rest/v19/intelligenceSetup/models/{modelId}/trainings

Use this endpoint to retrieve all trainings for the specified intelligence model.

Request

Path Parameters

• modelId(required): integer(int64)

Query Parameters

• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, all attributes are returned.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderby: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "ASC" or "DESC". Specify "ASC" for ascending and "DESC" for descending. The default value is "ASC". For example, ?orderby=field1:ASC,field2:DESC.
• q: string
  Filter (a ???where???clause) to restrict the items returned in the collection. By default, no filtering is applied.
• totalResults: boolean
  The resource collection representation will include the total row count when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/json

200 Response

Success

Body ()

Root Schema : PricingResourceCollection_IntelligenceTraining

Type: object

Show Source

• count: integer()
  Title: Count

  Read Only: true

  The number of resource instances returned in the current range.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• hasMore: boolean()
  Title: HasMore

  Read Only: true

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array items
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• limit: integer()
  Title: Limit

  Read Only: true

  The actual paging size used by the server.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• offset: integer()
  Title: OffSet

  Read Only: true

  The offset value used in the current page.
• totalResults: integer()
  Title: Total Results

  Read Only: true

  Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/IntelligenceTraining"
            }
        },
        "offset":{
            "type":"integer",
            "format":"",
            "description":"The offset value used in the current page.",
            "title":"OffSet",
            "readOnly":true
        },
        "limit":{
            "type":"integer",
            "format":"",
            "description":"The actual paging size used by the server.",
            "title":"Limit",
            "readOnly":true
        },
        "count":{
            "type":"integer",
            "format":"",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count",
            "readOnly":true
        },
        "totalResults":{
            "type":"integer",
            "format":"",
            "description":"Captures the total count of the resource instances, which not only includes the instances in the current range, but all instances on the server that satisfy the request.",
            "title":"Total Results",
            "readOnly":true
        },
        "hasMore":{
            "type":"boolean",
            "format":"",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : items

Type: array

Show Source

• Array of: object IntelligenceTraining

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

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : UserDetails

Type: object

Show Source

• emailId: string()
  Title: Email Id

  Email Id of the user
• firstName: string()
  Title: First Name

  First Name of the user
• lastName: string()
  Title: Last Name

  Last Name of the user

{
    "properties":{
        "firstName":{
            "type":"string",
            "format":"",
            "description":"First Name of the user",
            "title":"First Name"
        },
        "lastName":{
            "type":"string",
            "format":"",
            "description":"Last Name of the user",
            "title":"Last Name"
        },
        "emailId":{
            "type":"string",
            "format":"",
            "description":"Email Id of the user",
            "title":"Email Id"
        }
    }
}

Nested Schema : IntelligenceTraining

Type: object

Show Source

• analyticsInfo: string()
  Title: Training Information

  Read Only: true

  Information about the training.
• createdBy: Created By
  Title: Created By

  Read Only: true

  The details of the user who created the record.
• dateAdded: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Added

  Read Only: true

  Creation Date of the Training.
• dateModified: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Date Modified

  Read Only: true

  Last Modified date of the Training.
• duration: integer()
  Title: Duration

  Read Only: true

  Training duration.
• id: integer()
  Title: ID

  Read Only: true

  ID of the Intelligence Training.
• lastDeployed: string(yyyy-MM-dd'T'HH:mm:ss.SSS'Z')
  Title: Last Deployed

  Read Only: true

  Date of the training's last deployment.
• lastModifiedBy: Last Modified By
  Title: Last Modified By

  Read Only: true

  The details of the user who modified the record.
• learningTimeElapsed: string()
  Title: Learning Time

  Read Only: true

  Learning time elapsed.
• links: array Links
  Title: Links

  Read Only: true

  The link relations associated with the resource instance.
• message: string()
  Title: Message

  Read Only: true

  Training message.
• status: string()
  Title: Status

  Read Only: true

  Allowed Values: [ "Started", "Completed", "Failed" ]

  Training status.
• testErrorRate: number()
  Title: Test Error Rate

  Read Only: true

  Test error rate.
• totalRecords: integer()
  Title: Total Records

  Read Only: true

  Total number of records used for training.
• trainingErrorRate: number()
  Title: Training Error Rate

  Read Only: true

  Training error rate.

{
    "properties":{
        "createdBy":{
            "format":"",
            "description":"The details of the user who created the record.",
            "title":"Created By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "lastModifiedBy":{
            "format":"",
            "description":"The details of the user who modified the record.",
            "title":"Last Modified By",
            "readOnly":true,
            "allOf":[
                {
                    "$ref":"#/definitions/UserDetails"
                }
            ]
        },
        "id":{
            "type":"integer",
            "format":"",
            "description":"ID of the Intelligence Training.",
            "title":"ID",
            "readOnly":true
        },
        "dateModified":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Last Modified date of the Training.",
            "title":"Date Modified",
            "readOnly":true
        },
        "dateAdded":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Creation Date of the Training.",
            "title":"Date Added",
            "readOnly":true
        },
        "learningTimeElapsed":{
            "type":"string",
            "format":"",
            "description":"Learning time elapsed.",
            "title":"Learning Time",
            "readOnly":true
        },
        "duration":{
            "type":"integer",
            "format":"",
            "description":"Training duration.",
            "title":"Duration",
            "readOnly":true
        },
        "trainingErrorRate":{
            "type":"number",
            "format":"",
            "description":"Training error rate.",
            "title":"Training Error Rate",
            "readOnly":true
        },
        "testErrorRate":{
            "type":"number",
            "format":"",
            "description":"Test error rate.",
            "title":"Test Error Rate",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "format":"",
            "description":"Training status.",
            "title":"Status",
            "readOnly":true,
            "enum":[
                "Started",
                "Completed",
                "Failed"
            ]
        },
        "message":{
            "type":"string",
            "format":"",
            "description":"Training message.",
            "title":"Message",
            "readOnly":true
        },
        "analyticsInfo":{
            "type":"string",
            "format":"",
            "description":"Information about the training.",
            "title":"Training Information",
            "readOnly":true
        },
        "lastDeployed":{
            "type":"string",
            "format":"yyyy-MM-dd'T'HH:mm:ss.SSS'Z'",
            "description":"Date of the training's last deployment.",
            "title":"Last Deployed",
            "readOnly":true
        },
        "totalRecords":{
            "type":"integer",
            "format":"",
            "description":"Total number of records used for training.",
            "title":"Total Records",
            "readOnly":true
        },
        "links":{
            "type":"array",
            "format":"",
            "description":"The link relations associated with the resource instance.",
            "title":"Links",
            "readOnly":true,
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

Nested Schema : Created By

Title: Created By

Read Only: true

The details of the user who created the record.

Match All

The details of the user who created the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who created the record.",
    "title":"Created By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Last Modified By

Title: Last Modified By

Read Only: true

The details of the user who modified the record.

Match All

The details of the user who modified the record.

Show Source

• object UserDetails

{
    "format":"",
    "description":"The details of the user who modified the record.",
    "title":"Last Modified By",
    "readOnly":true,
    "allOf":[
        {
            "$ref":"#/definitions/UserDetails"
        }
    ]
}

Nested Schema : Links

Type: array

Title: Links

Read Only: true

The link relations associated with the resource instance.

Show Source

• Array of: object Link

{
    "type":"array",
    "format":"",
    "description":"The link relations associated with the resource instance.",
    "title":"Links",
    "readOnly":true,
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Show Source

• href: string
• name: string
• rel: string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "name":{
            "type":"string"
        }
    }
}

Back to Top

Examples

The following examples show how to retrieve all trainings for the specified intelligence model by submitting a GET request to the REST resource using cURL. For more information about cURL, see Use cURL.

The 'limit' query specification is used in the following example to limit the results to three models per page.

curl - X GET -H "Authorization: Bearer <token>" - H "Content-type: application/json"
https://sitename.oracle.com/rest/v19/intelligenceSetup/models/334523/trainings

Response Body Sample

{
  "items": [{
      "createdBy": {
        "firstName": "Alex",
        "lastName": "Smith",
        "emailId": "[e-mail]"
      },
      "lastModifiedBy": {
        "firstName": "Alex",
        "lastName": "Smith",
        "emailId": "[e-mail]"
      },
      "id": 3023602739,
      "dateModified": "2025-02-27T10:13:23Z",
      "dateAdded": "2025-02-27T10:12:01Z",
      "learningTimeElapsed": "72",
      "duration": 0,
      "status": "Completed",
      "message": "The model was built successfully.",
      "lastDeployed": "2025-02-27T10:13:23Z",
      "totalRecords": 2132
    }, {
      "createdBy": {
        "firstName": "Alex",
        "lastName": "Smith",
        "emailId": "[e-mail]"
      },
      "id": 3023620982,
      "dateModified": "2025-03-08T20:42:00Z",
      "dateAdded": "2025-03-08T20:40:32Z",
      "learningTimeElapsed": "83",
      "duration": 0,
      "status": "Completed",
      "message": "The model was built successfully.",
      "totalRecords": 2521
    }
  ],
  "offset": 0,
  "limit": 1000,
  "count": 2,
  "hasMore": false
}

Back to Top