Item Lifecycle - Create Item

Υπηρεσία:

Workload Development

Έκδοση API:

v1

Καλείται από το Microsoft Fabric για τη δημιουργία ενός νέου στοιχείου.
Κατά τη δημιουργία του στοιχείου Το Fabric εκτελεί βασικές επικυρώσεις, δημιουργεί το στοιχείο σε κατάσταση προμήθειας και καλεί αυτό το API για να ειδοποιήσει τον φόρτο εργασίας. Ο φόρτος εργασίας αναμένεται να εκτελέσει τις απαιτούμενες επικυρώσεις, να αποθηκεύσει τα μετα-δεδομένα του στοιχείου, να κατανείμει τους απαιτούμενους πόρους και να ενημερώσει το cache μετα-δεδομένων στοιχείων Fabric με τις σχέσεις στοιχείων και το ETag.

Αυτό το API θα πρέπει να δέχεται έλεγχο ταυτότητας SubjectAndApp.

Δικαιώματα

Τα δικαιώματα ελέγχονται από το Microsoft Fabric.

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/{workspaceId}/items/{itemType}/{itemId}

Παράμετροι URI

Όνομα	Σε	Απαιτείται	Τύπος	Περιγραφή
itemId	path	True	string uuid	Το αναγνωριστικό στοιχείου.
itemType	path	True	string	Ο τύπος στοιχείου.
workspaceId	path	True	string uuid	Το αναγνωριστικό χώρου εργασίας.

Κεφαλίδα αίτησης

Όνομα	Απαιτείται	Τύπος	Περιγραφή
ActivityId	True	string	Ένα μοναδικό αναγνωριστικό για τη συσχέτιση της αίτησης με το σύστημά σας όταν ένας χρήστης αλληλεπιδρά με τον φόρτο εργασίας σας.
RequestId	True	string	Ένα καθολικά μοναδικό αναγνωριστικό που βοηθά το Fabric να συσχετίσει την αίτησή σας με τα αρχεία καταγραφής. Καταχωρήστε αυτό το αναγνωριστικό κατά την αναφορά ενός προβλήματος.
Authorization	True	string	Μια κεφαλίδα ελέγχου ταυτότητας δύο διακριτικών που επιτρέπει στον φόρτο εργασίας να επικυρώνει την προέλευση της αίτησης, να παρέχει περιβάλλον χρήστη και να καλεί άλλες υπηρεσίες. Αυτή η κεφαλίδα έχει την ακόλουθη μορφή: SubjectAndAppToken1.0 subjectToken="delegated token", appToken="S2S token".
x-ms-client-tenant-id	True	string	Το αναγνωριστικό μισθωτή του προγράμματος-πελάτη που πραγματοποιεί την αίτηση.

Κυρίως τμήμα αίτησης

Όνομα	Απαιτείται	Τύπος	Περιγραφή
displayName	True	string	Το εμφανιζόμενο όνομα του στοιχείου. Δεν μπορεί να υπερβεί τους 256 χαρακτήρες.
creationPayload		object	Ωφέλιμο φορτίο δημιουργίας που αφορά ειδικά τον τύπο φόρτου εργασίας και στοιχείου. Διαβιβάζεται από το πρόγραμμα επεξεργασίας στοιχείων ή ως παράμετρος API αυτοματισμού Fabric.
description		string	Η περιγραφή του στοιχείου.

Αποκρίσεις

Όνομα	Τύπος	Περιγραφή
200 OK		Δημιουργήθηκε με επιτυχία.
Other Status Codes	ErrorResponse	Για συνθήκες σφάλματος, ο φόρτος εργασίας θα πρέπει να επιστρέψει έναν κατάλληλο κωδικό κατάστασης σφάλματος HTTP (4xx, 5xx) με λεπτομερείς πληροφορίες σφάλματος στο σώμα της απόκρισης.

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

Create item example

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

HTTP

POST https://workload.contoso.com/workload-api-path-placeholder/workspaces/e5ef604d-e14f-4a59-9133-75d5a0cb9334/items/Contoso.FinanceAnalytics.Forecast/b14cb7e7-d346-4751-9cfd-8c2767d53111

{
  "displayName": "Forecast 1",
  "description": "The 1st forecast item",
  "creationPayload": {
    "algorithm": "ExponentialSmoothing"
  }
}

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

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

200

Ορισμοί

Όνομα	Περιγραφή
CreateItemRequest	Δημιουργία περιεχομένου αίτησης στοιχείου.
ErrorExtendedInformation	Οι εκτεταμένες πληροφορίες σφάλματος.
ErrorResponse	Η απόκριση σφάλματος.
ErrorSource	Η προέλευση του σφάλματος.
NameValuePair	Ένα ζεύγος ονόματος-τιμής.

CreateItemRequest

Object

Δημιουργία περιεχομένου αίτησης στοιχείου.

Όνομα	Τύπος	Περιγραφή
creationPayload	object	Ωφέλιμο φορτίο δημιουργίας που αφορά ειδικά τον τύπο φόρτου εργασίας και στοιχείου. Διαβιβάζεται από το πρόγραμμα επεξεργασίας στοιχείων ή ως παράμετρος API αυτοματισμού Fabric.
description	string	Η περιγραφή του στοιχείου.
displayName	string	Το εμφανιζόμενο όνομα του στοιχείου. Δεν μπορεί να υπερβεί τους 256 χαρακτήρες.

ErrorExtendedInformation

Object

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

Όνομα	Τύπος	Περιγραφή
additionalParameters	NameValuePair[]	Μια λίστα πρόσθετων παραμέτρων ειδικά για το σφάλμα.
errorCode	string	Ο κωδικός σφάλματος.
message	string	Το μήνυμα σφάλματος.
messageParameters	string[]	Μια λίστα παραμέτρων για τη μορφοποίηση ενός μεταφρασμένου μηνύματος.

ErrorResponse

Object

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

Όνομα	Τύπος	Περιγραφή
errorCode	string	Ο κωδικός σφάλματος.
isPermanent	boolean	Υποδεικνύει εάν το σφάλμα είναι μόνιμο ή μπορεί να επαναληφθεί η λειτουργία.
message	string	Το μήνυμα σφάλματος.
messageParameters	string[]	Μια λίστα παραμέτρων για τη μορφοποίηση ενός μεταφρασμένου μηνύματος.
moreDetails	ErrorExtendedInformation[]	Μια λίστα πρόσθετων λεπτομερειών σφάλματος.
source	ErrorSource	Η προέλευση σφάλματος.

ErrorSource

Απαρίθμηση

Η προέλευση του σφάλματος.

Τιμή	Περιγραφή
External
System
User

NameValuePair

Object

Ένα ζεύγος ονόματος-τιμής.

Όνομα	Τύπος	Περιγραφή
name	string	Το όνομα.
value	string	Η τιμή.