scan_groups API: scan бүлгийн мэдээлэл авах

Энэ API нь scan бүлгүүдийн (scan group) мэдээллийг буцаана.

Хүсэлт

Формат

GET /setting/scan_groups/{id}

Параметрүүд

• id — String; заавал биш: Тийм; мэдээллийг нь харуулах scan бүлгийн ID. Хүсэлтэд энэ параметрийг заагаагүй бол хариунд таны компанид үүсгэсэн бүх scan бүлгийн мэдээлэл орно.

Жишээнүүд

Компанийн бүх scan бүлгийн мэдээллийг хүсэх:

GET /setting/scan_groups

16beea3e-d011-4c0c-932c-8d8e53****** scan бүлгийн мэдээллийг хүсэх:

GET /setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******

Хариу

Формат

{
  "data": [
    {
      "id": "string",
      "type": "scan_group",
      "attributes": {
        "name": "string",
        "description": "string",
        "schedule": "string",
        "created_at": "2024-01-04T15:07:59.329Z"
      },
      "relationships": {
        "scans": {
          "data": [
            {
              "id": "string",
              "type": "scan"
            }
          ]
        }
      },
      "links": {
        "self": "string"
      }
    }
  ],
  "links": {
    "self": "string",
    "next": "string"
  },
  "meta": {
    "total": 0,
    "elapsed": 0
  }
}

Атрибутууд

Энэ endpoint нь scan бүлгийн тохиргооны мэдээллийг тус тусад нь агуулсан олон атрибуттай обьект буцаана.

• data — Object; scan бүлэгтэй холбоотой мэдээллийг агуулсан атрибутуудын жагсаалт.
• id — String; scan бүлгийн ID.
• type — String; обьектын тодорхойлж буй зүйлийн төрөл. Боломжит утга: scan_group.
• attributes — Array of Strings; scan бүлгийн мэдээллийг өгнө.
• name — String; scan бүлгийн нэр.
• description — String; scan бүлгийн тодорхойлолт.
• schedule — String; scan бүлэгт оноосон шалгалтын (scan) хуваарь.
• created_at — String; scan бүлгийг үүсгэсэн цаг, огноо.
• relationships — Object; холбогдох обьектуудын жагсаалт.
• scans — Object; энэ scan бүлэгт хамаарах scan бүртгэлүүдийн жагсаалт.
• data — Array of Strings; холбогдох scan бүртгэлийн мэдээллийг агуулсан жагсаалт.
• id — String; холбогдох scan бүртгэлийн ID.
• type — String; холбогдох обьектын төрөл. Боломжит утга: scan.
• links — Array of Strings; энэ scan бүлэгт хамаарах холбоосуудыг өгнө.
• self — String; энэ тодорхой scan бүлгийн мэдээлэл рүү шууд очих холбоос.
• Доорх атрибутууд нь компанийн бүх scan бүлгийн мэдээллийг хүссэн үед (хүсэлтэд id заагаагүй үед) л буцаагдана.
• links — Array of Strings; хуудсуудын хооронд шилжих холбоосуудыг өгнө.
• self — String; энэ тодорхой scan бүлгийн мэдээлэл рүү шууд очих холбоос.
• next — String; хүсэлтийн буцаасан дараагийн scan бүлгийн мэдээлэл рүү шууд очих холбоос.
• meta — Array of Integers; хүсэлтийн буцаасан мэдээллийн ерөнхий мэдээллийг өгнө.
• total — Integer; хүсэлтийн буцаасан үр дүнгийн нийт тоо.
• elapsed — Integer; одоо харуулж буйг оруулаад таны үзсэн үр дүнгийн тоо.

Жишээнүүд:

Компанийн бүх scan бүлгийн мэдээллийг хүссэн тохиолдол:

{
    "data": [
        {
            "id": "11e1623b-6d41-42e1-9c62-f8c682******",
            "type": "scan_group",
            "attributes": {
                "name": "Test Scan",
                "description": "For demo day",
                "schedule": "0 1 * * 1",
                "created_at": "2023-09-27T09:12:56+00:00"
            },
            "relationships": {
                "scans": {
                    "data": []
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/11e1623b-6d41-42e1-9c62-f8c682******"
            }
        },
        {
            "id": "16beea3e-d011-4c0c-932c-8d8e53******",
            "type": "scan_group",
            "attributes": {
                "name": "demo-group",
                "description": "",
                "schedule": "0 17 * * 0",
                "created_at": "2023-09-26T08:09:44+00:00"
            },
            "relationships": {
                "scans": {
                    "data": [
                        {
                            "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                            "type": "scan"
                        },
                        {
                            "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                            "type": "scan"
                        },
                        {
                            "id": "3c807067-4097-43ac-82d7-4ee2ef******",
                            "type": "scan"
                        },
                        {
                            "id": "6d1422ac-9eea-45e2-992e-27a243******",
                            "type": "scan"
                        }
                    ]
                }
            },
            "links": {
                "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
            }
        },
        {
            "...": "..."
        }
    ],
    "links": {
        "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups?page_limit=500",
        "next": null
    },
    "meta": {
        "total": 7,
        "elapsed": 7
    }
}

16beea3e-d011-4c0c-932c-8d8e53****** scan бүлгийн мэдээллийг хүссэн тохиолдол:

{
    "data": {
        "id": "16beea3e-d011-4c0c-932c-8d8e53******",
        "type": "scan_group",
        "attributes": {
            "name": "demo-group",
            "description": "",
            "schedule": "0 17 * * 0",
            "created_at": "2023-09-26T08:09:44+00:00"
        },
        "relationships": {
            "scans": {
                "data": [
                    {
                        "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                        "type": "scan"
                    },
                    {
                        "id": "6139d266-4eb6-49fe-b8d2-d17cd7******",
                        "type": "scan"
                    },
                    {
                        "id": "3c807067-4097-43ac-82d7-4ee2ef******",
                        "type": "scan"
                    },
                    {
                        "id": "6d1422ac-9eea-45e2-992e-27a243******",
                        "type": "scan"
                    }
                ]
            }
        },
        "links": {
            "self": "https://api.staging.cs.gravityzone.bitdefender.com/v1/setting/scan_groups/16beea3e-d011-4c0c-932c-8d8e53******"
        }
    }
}