GetRequest
E702746
GetRequest is a standard single-item retrieval operation or message type commonly used in APIs or network protocols to request a specific resource or piece of data.
Statements (46)
| Predicate | Object |
|---|---|
| instanceOf |
API operation type
ⓘ
network protocol message type ⓘ |
| belongsToPattern | request-response pattern ⓘ |
| canBe |
authenticated
ⓘ
authorized ⓘ |
| commonlyUsedFor |
fetching resource representations
ⓘ
reading configuration data ⓘ retrieving records by identifier ⓘ |
| expects | response message ⓘ |
| hasAbstractionLevel | application layer ⓘ |
| hasCardinality | single-item retrieval ⓘ |
| hasConceptualEquivalent | HTTP GET method ⓘ |
| hasConstraint | must specify target resource ⓘ |
| hasDesignGoal |
efficiency for reads
ⓘ
simplicity ⓘ |
| hasDirection | client-to-server ⓘ |
| hasErrorCondition |
forbidden access
ⓘ
invalid parameters ⓘ resource not found ⓘ unauthorized access ⓘ |
| hasKeyProperty |
idempotent behavior
ⓘ
read-only semantics ⓘ |
| hasPurpose |
retrieve a specific piece of data
ⓘ
retrieve a specific resource ⓘ |
| hasResponseCharacteristic |
may return requested data payload
ⓘ
may return success or error status ⓘ |
| hasSemanticRole | read operation in CRUD model ⓘ |
| hasTypicalUseCase |
checking status of a resource
ⓘ
reading a single resource by ID ⓘ retrieving metadata for an entity ⓘ |
| initiatedBy | client ⓘ |
| isPartOf |
API contract
ⓘ
protocol specification ⓘ |
| mayBe | cached by intermediaries ⓘ |
| mayInclude |
headers
ⓘ
query parameters ⓘ resource identifier ⓘ |
| processedBy | server ⓘ |
| relatedTo |
CreateRequest
ⓘ
DeleteRequest ⓘ UpdateRequest ⓘ |
| shouldNot | modify server state ⓘ |
| usedIn |
RESTful APIs
ⓘ
client-server communication ⓘ network protocols ⓘ web APIs ⓘ |
Referenced by (1)
Full triples — surface form annotated when it differs from this entity's canonical label.