PlainApp
API குறிப்பு

குறிப்புகள்

அம்ச ஆதரவிற்கு app.capabilities-ஐயும் அனுமதிக்கு app.access மற்றும் host அனுமதிகளையும் சரிபார்க்கவும். எடுத்துக்காட்டுகள் செயற்கை மதிப்புகளைப் பயன்படுத்துகின்றன; அழைப்பதற்கு முன் பாதைகள், ID-கள், உள்ளீடுகள் மற்றும் வடிப்பான்களை மாற்றவும்.

வகை வரையறைகள்

graphql
type Mutation {
  createNote(input: NoteInput!): Note!
  deleteNotes(query: String!): ActionResult!
  restoreNotes(query: String!): ActionResult!
  saveFeedEntriesToNotes(query: String!): [ID!]!
  trashNotes(query: String!): ActionResult!
  updateNote(id: ID!, input: NoteInput!): Note!
}

type Query {
  exportNotes(query: String!): String!
  note(id: ID!): Note
  noteCount(query: String!): Int!
  notes(query: String!, offset: Int!, limit: Int!): [Note!]!
}

type ActionResult {
	affectedCount: Int!
}

enum DataType {
	DEFAULT
	AUDIO
	VIDEO
	IMAGE
	SMS
	CONTACT
	NOTE
	FEED_ENTRY
	CALL
	PACKAGE
	FILE
	APP_FILE
	DOC
}

scalar Instant

type Note {
	id: ID!
	title: String!
	content: String!
	deletedAt: Instant
	createdAt: Instant!
	updatedAt: Instant!
	tags: [Tag!]!
}

input NoteInput {
	title: String!
	content: String!
}

type Tag {
	id: ID!
	name: String!
	type: DataType!
	count: Int!
}

செயல்பாடுகள்

mutation

createNote

கொடுக்கப்பட்ட உள்ளீட்டிலிருந்து குறிப்பை உருவாக்கி நிலையாகச் சேமிக்கவும்.

graphql
mutation createNote($input: NoteInput!) {
  createNote(input: $input) { id title content deletedAt createdAt updatedAt }
}
mutation

deleteNotes

வினவலுக்குப் பொருந்தும் குப்பைக் குறிப்புகளை நிரந்தரமாக நீக்கவும். ஏற்கெனவே குப்பையிலுள்ள குறிப்புகளில் மட்டுமே செயல்படும்.

graphql
mutation deleteNotes($query: String!) {
  deleteNotes(query: $query) { affectedCount }
}
mutation

restoreNotes

வினவலுக்குப் பொருந்தும் குப்பைக் குறிப்புகளை மீட்டெடுக்கவும்.

graphql
mutation restoreNotes($query: String!) {
  restoreNotes(query: $query) { affectedCount }
}
mutation

saveFeedEntriesToNotes

பொருந்தும் ஊட்டப் பதிவுகளைக் குறிப்புகளாகச் சேமித்து உருவாக்கப்பட்ட குறிப்பு ID-களைத் தரவும்.

graphql
mutation saveFeedEntriesToNotes($query: String!) {
  saveFeedEntriesToNotes(query: $query)
}
mutation

trashNotes

வினவலுக்குப் பொருந்தும் குறிப்புகளைக் குப்பைக்கு நகர்த்தவும்.

graphql
mutation trashNotes($query: String!) {
  trashNotes(query: $query) { affectedCount }
}
mutation

updateNote

கொடுக்கப்பட்ட உள்ளீட்டிலிருந்து சேமிக்கப்பட்ட குறிப்பைப் புதுப்பிக்கவும்.

graphql
mutation updateNote($id: ID!, $input: NoteInput!) {
  updateNote(id: $id, input: $input) { id title content deletedAt createdAt updatedAt }
}
query

exportNotes

காப்புப்பிரதி/பரிமாற்றத்திற்காக வினவலுக்குப் பொருந்தும் குறிப்புகளைக் குறிச்சொற்களுடன் JSON சரமாக வரிசையாக்கவும்.

graphql
query exportNotes($query: String!) {
  exportNotes(query: $query)
}
query

note

ID மூலம் ஒரு குறிப்பைப் பெறவும்.

graphql
query note($id: ID!) {
  note(id: $id) { id title content deletedAt createdAt updatedAt }
}
query

noteCount

வினவலுக்குப் பொருந்தும் குறிப்புகளை எண்ணவும்.

graphql
query noteCount($query: String!) {
  noteCount(query: $query)
}
query

notes

குறிப்புகளின் தலைப்பிலும் உள்ளடக்கத்திலும் தேடவும். குப்பையில் இல்லாத அனைத்துக் குறிப்புகளையும் பட்டியலிட query-ஐ வெறுமையாக விடவும்.

graphql
query notes($query: String!, $offset: Int!, $limit: Int!) {
  notes(query: $query, offset: $offset, limit: $limit) { id title content deletedAt createdAt updatedAt }
}