Items - Get Graph Model Definition

Υπηρεσία:: GraphModel

Έκδοση API:: v1

Επιστρέφει τον καθορισμένο δημόσιο ορισμό GraphModel.

Σημείωμα

Το στοιχείο GraphModel είναι αυτήν τη στιγμή σε έκδοση προεπισκόπησης (μάθετε περισσότερα).

Αυτό το API υποστηρίζει λειτουργίες μεγάλης διάρκειας (LRO).

Όταν λαμβάνετε τον δημόσιο ορισμό ενός GraphModel, η ετικέτα ευαισθησίας δεν αποτελεί μέρος του ορισμού.

Δικαιώματα

Ο καλών πρέπει να έχει δικαιώματα ανάγνωσης και εγγραφής για το GraphModel.

Απαιτούμενες εμβέλειες με ανάθεση

Item.ReadWrite.All

υποστηριζόμενες ταυτότητες Microsoft Entra

Αυτό το API υποστηρίζει τις ταυτότητες Microsoft που παρατίθενται σε αυτή την ενότητα.

Identity	Υποστήριξη
User	Ναι
Υπηρεσίας και διαχειριζόμενες ταυτότητες	Ναι

Διασύνδεση

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition

Με προαιρετικές παραμέτρους:

POST https://api.fabric.microsoft.com/v1/workspaces/{workspaceId}/graphModels/{graphModelId}/getDefinition?format={format}

Παράμετροι URI

Ονομασία	Σε	Απαιτείται	Τύπος	Περιγραφή
graphModelId	path	True	string (uuid)	Το αναγνωριστικό GraphModel.
workspaceId	path	True	string (uuid)	Το αναγνωριστικό χώρου εργασίας.
format	query		string	Η μορφή του δημόσιου ορισμού GraphModel.

Αποκρίσεις

Ονομασία	Τύπος	Περιγραφή
200 OK	GraphModelDefinitionResponse	Η αίτηση ολοκληρώθηκε με επιτυχία.
202 Accepted		Η αίτηση έγινε δεκτή. Η ανάκτηση του ορισμού βρίσκεται σε εξέλιξη. Κεφαλίδες Location: string x-ms-operation-id: string Retry-After: integer
429 Too Many Requests	ErrorResponse	Έγινε υπέρβαση του ορίου επιτοκίου υπηρεσίας. Ο διακομιστής επιστρέφει μια `Retry-After` κεφαλίδα που υποδεικνύει, σε δευτερόλεπτα, πόσο πρέπει να περιμένει ο υπολογιστής-πελάτης πριν από την αποστολή πρόσθετων αιτήσεων. Κεφαλίδες Retry-After: integer
Other Status Codes	ErrorResponse	Συνήθεις κωδικοί σφαλμάτων: OperationNotSupportedForItem - Η λειτουργία δεν υποστηρίζεται για το στοιχείο που ζητήθηκε.

Παραδείγματα

Get a GraphModel public definition example

Δείγμα αίτησης

HTTP

POST https://api.fabric.microsoft.com/v1/workspaces/6e335e92-a2a2-4b5a-970a-bd6a89fbb765/graphModels/cfafbeb1-8037-4d0c-896e-a46fb27ff229/getDefinition

Δείγμα απόκρισης

Κωδικός κατάστασης:: 200

{
  "definition": {
    "format": "json",
    "parts": [
      {
        "path": "graphType.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "graphDefinition.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "dataSources.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": "stylingConfiguration.json",
        "payload": "eyJleGVjdXRhYmxlRm..OWRmNDhhY2ZmZTgifQ==",
        "payloadType": "InlineBase64"
      },
      {
        "path": ".platform",
        "payload": "ZG90UGxhdGZvcm1CYXNlNjRTdHJpbmc=",
        "payloadType": "InlineBase64"
      }
    ]
  }
}

Κωδικός κατάστασης:: 202

Location: https://api.fabric.microsoft.com/v1/operations/431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
x-ms-operation-id: 431e8d7b-4a95-4c02-8ccd-6faef5ba1bd7
Retry-After: 30

Ορισμοί

Ονομασία	Περιγραφή
ErrorParameter	Μια δομημένη παράμετρος που παρέχει πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με ένα σφάλμα.
ErrorRelatedResource	Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.
ErrorResponse	Η απόκριση σφάλματος.
ErrorResponseDetails	Οι λεπτομέρειες της απόκρισης σφάλματος.
GraphModelDefinitionFormat	Η μορφή του ορισμού μοντέλου γραφήματος. Επιπλέον `format` τύποι μπορούν να προστεθούν με την πάροδο του χρόνου.
GraphModelDefinitionResponse	Απόκριση δημόσιου ορισμού GraphModel.
GraphModelPublicDefinition	Αντικείμενο δημόσιου ορισμού GraphModel. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού GraphModel.
GraphModelPublicDefinitionPart	Αντικείμενο τμήματος ορισμού GraphModel.
PayloadType	Ο τύπος του ωφέλιμου φορτίου τμήματος ορισμού. Επιπλέον τύποι ωφέλιμου φορτίου μπορούν να προστεθούν με την πάροδο του χρόνου.

ErrorParameter

Αντικείμενο

Μια δομημένη παράμετρος που παρέχει πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με ένα σφάλμα.

Ονομασία	Τύπος	Περιγραφή
message	string	Μια αναγνώσιμη από τον άνθρωπο περιγραφή της έννοιας της παραμέτρου.
name	string	Το αναγνωριστικό παραμέτρου.
value	string	Η τιμή της παραμέτρου.

ErrorRelatedResource

Αντικείμενο

Το αντικείμενο λεπτομερειών πόρου που σχετίζεται με το σφάλμα.

Ονομασία	Τύπος	Περιγραφή
resourceId	string	Το αναγνωριστικό πόρου που εμπλέκεται στο σφάλμα.
resourceType	string	Ο τύπος του πόρου που εμπλέκεται στο σφάλμα.

ErrorResponse

Αντικείμενο

Η απόκριση σφάλματος.

Ονομασία	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
isRetriable	boolean	Όταν είναι true, η αίτηση μπορεί να επαναληφθεί. Χρησιμοποιήστε την `Retry-After` κεφαλίδα απόκρισης για να προσδιορίσετε την καθυστέρηση, εάν υπάρχει.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
moreDetails	ErrorResponseDetails[]	Λίστα πρόσθετων λεπτομερειών σφάλματος.
parameters	ErrorParameter[]	Δομημένες παράμετροι που παρέχουν πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με το σφάλμα.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.
requestId	string (uuid)	Το αναγνωριστικό της αίτησης που σχετίζεται με το σφάλμα.

ErrorResponseDetails

Αντικείμενο

Οι λεπτομέρειες της απόκρισης σφάλματος.

Ονομασία	Τύπος	Περιγραφή
errorCode	string	Ένα συγκεκριμένο αναγνωριστικό που παρέχει πληροφορίες σχετικά με μια συνθήκη σφάλματος, επιτρέποντας τυποποιημένη επικοινωνία μεταξύ της υπηρεσίας μας και των χρηστών της.
message	string	Μια αναγνώσιμη αναπαράσταση του σφάλματος.
parameters	ErrorParameter[]	Δομημένες παράμετροι που παρέχουν πρόσθετο περιβάλλον αναγνώσιμο από υπολογιστή σχετικά με το σφάλμα.
relatedResource	ErrorRelatedResource	Οι λεπτομέρειες του πόρου που σχετίζονται με το σφάλμα.

GraphModelDefinitionFormat

Απαρίθμηση

Η μορφή του ορισμού μοντέλου γραφήματος. Επιπλέον format τύποι μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
json	Μορφή JSON για τον δημόσιο ορισμό GraphModel, ειδικά σχεδιασμένος για την υποστήριξη σεναρίων CI/CD στο Fabric.

GraphModelDefinitionResponse

Αντικείμενο

Απόκριση δημόσιου ορισμού GraphModel.

Ονομασία	Τύπος	Περιγραφή
definition	GraphModelPublicDefinition	Αντικείμενο δημόσιου ορισμού GraphModel. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού GraphModel.

GraphModelPublicDefinition

Αντικείμενο

Αντικείμενο δημόσιου ορισμού GraphModel. Ανατρέξτε σε αυτό το άρθρο για περισσότερες λεπτομέρειες σχετικά με τη δομή του ορισμού GraphModel.

Ονομασία	Τύπος	Περιγραφή
format	GraphModelDefinitionFormat	Η μορφή του ορισμού μοντέλου γραφήματος. Επιπλέον `format` τύποι μπορούν να προστεθούν με την πάροδο του χρόνου.
parts	GraphModelPublicDefinitionPart[]	Μια λίστα τμημάτων ορισμού.

GraphModelPublicDefinitionPart

Αντικείμενο

Αντικείμενο τμήματος ορισμού GraphModel.

Ονομασία	Τύπος	Περιγραφή
path	string	Η διαδρομή τμήματος δημόσιου ορισμού GraphModel.
payload	string	Το ωφέλιμο φορτίο τμήματος δημόσιου ορισμού GraphModel.
payloadType	PayloadType	Ο τύπος ωφέλιμου φορτίου.

PayloadType

Απαρίθμηση

Ο τύπος του ωφέλιμου φορτίου τμήματος ορισμού. Επιπλέον τύποι ωφέλιμου φορτίου μπορούν να προστεθούν με την πάροδο του χρόνου.

Τιμή	Περιγραφή
InlineBase64	Ενσωματωμένη βάση 64.