Searching service
    • PDF

    Searching service

    • PDF

    Article summary

    The latest service changes have not yet been reflected in this content. We will update the content as soon as possible. Please refer to the Korean version for information on the latest updates.

    Search a service.

    GET https://aitems.apigw.ntruss.com/api/v1/services/{serviceId}
    

    Requests

    Request parameters

    ParametersRequirement statusTypeRestrictionsDescription
    serviceIdYesStringService ID created

    Responses

    FieldTypeDescriptionNote
    serviceIdStringService ID
    nameStringService name
    descriptionStringService description
    statusStringService status
    datasets[].datasetIdStringDataset ID set to the service
    datasets[].typeStringDataset type set to the service
    datasets[].nameStringDataset name set to the service
    datasets[].schemaNameStringDataset schema name set to the service
    datasets[].statusStringDataset status set to the service
    datasets[].createdDateStringDataset creation date set to the service
    datasets[].updatedDateStringLast update of dataset set to the service
    hpConfig.is_enabledBooleanHPO setting status
    hpConfig.{option}StringSet HPO value
    infers[].dataTypeStringLearning result dataset type
    infers[].trainVersionStringLearning result version
    infers[].statusStringLearning result status
    infers[].rowCountStringNumber of learning results
    createdDateStringService creation date
    updatedDateStringLast update
    typeStringService type
    learningIntervalStringUpdate cycle
    scheduledDateStringUpdate base time

    Response status

    HTTP StatusDesc
    200OK (Successfully searched)
    400Bad Request
    401Unauthorized
    403Forbidden
    404Not Found
    500Internal Server Error

    Examples

    Request examples

    GET /api/v1/services/49qkb0fbnar
    Host: aitems.apigw.ntruss.com
    accept: application/json
    x-ncp-iam-access-key: {Access key}
    x-ncp-apigw-signature-v2: {API GW signature}
    x-ncp-apigw-timestamp: {timestamp}
    

    Response examples

    {
      "serviceId": "49qkb0fbnar",
      "name": "movie-service",
      "description": "",
      "status": "learnable",
      "datasets": [
        {
          "datasetId": "7qkv2ox8211",
          "type": "interaction",
          "name": "m-interaction",
          "schemaName": "movie_interaction",
          "status": "learnable",
          "createdDate": "2021-09-15T18:19:22.709",
          "updatedDate": "2021-11-22T17:03:35.844"
        },
        {
          "datasetId": "qc80eu7udo9",
          "type": "user",
          "name": "m-user",
          "schemaName": "movie_user",
          "status": "learnable",
          "createdDate": "2021-09-15T18:18:58.123",
          "updatedDate": "2021-11-22T16:01:38.486"
        },
        {
          "datasetId": "ap0l4f72e9f",
          "type": "item",
          "name": "m-item",
          "schemaName": "movie_item",
          "status": "learnable",
          "createdDate": "2021-09-15T18:19:10.454",
          "updatedDate": "2021-11-22T17:04:35.977"
        }
      ],
      "hpConfig": {
        "is_enabled": false,
        "group_column": [
          "AGE"
        ]
      },
      "infers": [
        {
          "dataType": "personalRecommend",
          "trainVersion": "owpayt7nw1n",
          "status": "enable",
          "rowCount": 1113,
          "createdDate": "2021-11-24T15:24:06.62",
          "updatedDate": "2021-11-24T15:24:18.162"
        },
        {
          "dataType": "relatedItem",
          "trainVersion": "owpayt7nw1n",
          "status": "enable",
          "rowCount": 2641,
          "createdDate": "2021-11-24T15:24:06.686",
          "updatedDate": "2021-11-24T15:24:20.902"
        },
        {
          "dataType": "pop",
          "trainVersion": "owpayt7nw1n",
          "status": "enable",
          "rowCount": 92,
          "createdDate": "2021-11-24T15:17:29.353",
          "updatedDate": "2021-11-24T15:17:39.565"
        }
      ],
      "createdDate": "2021-09-29T11:36:50.217",
      "updatedDate": "2021-11-24T15:24:20.985",
      "type": "interval",
      "learningInterval": "hour6",
      "scheduledDate": "2021-11-18T15:17:12.968"
    }
    

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.