Jump to

• Request
• Response

Insert record/records into record collection

post

/gsdata/v1/{appName}/data/{recordCollection}

Insert records into the specified record collection. If record with the same id already exist in the collection it will be overwritten. Users must not manipulate system created record collections, eg records in /cloud/data/catalog, as these changes would be overridden on the next catalog indexing event.

Request

Supported Media Types

• application/json

Path Parameters

• appName: string
  Specifies the name of your application. For example, "cloud".
• recordCollection: string
  Name of the record collection. A valid record collection name is defined by the regular expression "^[a-zA-Z0-9._-]+$" and cannot exceed 128 characters.

Body ()

Represents a list of guided search records.

Root Schema : RecordList

Type: object

Represents a list of guided search records.

Show Source

• items(optional): array items
• links(optional): array links

{
    "type":"object",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/RecordItem"
            }
        }
    },
    "description":"Represents a list of guided search records."
}

Nested Schema : items

Type: array

Show Source

• Array of: object RecordItem
  Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/RecordItem"
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Represents a link to a gsdata resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : RecordItem

Type: object

Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties.

Show Source

• record.action(optional): string
  Allowed Values: [ "upsert", "delete" ]
• record.collection(optional): string
• record.id(optional): string
• record.locale(optional): string
• record.urn(optional): string

{
    "type":"object",
    "properties":{
        "record.id":{
            "type":"string"
        },
        "record.action":{
            "type":"string",
            "enum":[
                "upsert",
                "delete"
            ]
        },
        "record.collection":{
            "type":"string"
        },
        "record.urn":{
            "type":"string"
        },
        "record.locale":{
            "type":"string"
        }
    },
    "description":"Represents a record from a Guided Search record collection. As well as the properties listed below a record will also have 1 or more additional properties."
}

Nested Schema : Link

Type: object

Represents a link to a gsdata resource.

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"Represents a link to a gsdata resource."
}

Security

• basicAuth: basic
  Type: basic

  Description: Basic username/password authentication.

Back to Top

Response

Supported Media Types

• application/json

201 Response

POST request was successful.

Body ()

Root Schema : PostRecordsResponse

Type: object

Represents the response received from a POST request to insert records into record collection.

Show Source

• importRecordsStatus(optional): object ImportRecordsStatus
  Represents a status of records being imported by this POST request.
• importRecordsSummary(optional): object ImportRecordsSummary
  Represents a summary of records imported by this POST request.
• links(optional): array links
• status(optional): integer
• title(optional): string

{
    "type":"object",
    "properties":{
        "status":{
            "type":"integer"
        },
        "title":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "importRecordsSummary":{
            "$ref":"#/definitions/ImportRecordsSummary"
        },
        "importRecordsStatus":{
            "$ref":"#/definitions/ImportRecordsStatus"
        }
    },
    "description":"Represents the response received from a POST request to insert records into record collection."
}

Nested Schema : ImportRecordsStatus

Type: object

Represents a status of records being imported by this POST request.

Show Source

• numCommits(optional): integer
• numRecordsCommitted(optional): integer
• numRecordsInQueue(optional): integer
• numRecordsPendingCommit(optional): integer

{
    "type":"object",
    "properties":{
        "numRecordsInQueue":{
            "type":"integer"
        },
        "numRecordsPendingCommit":{
            "type":"integer"
        },
        "numRecordsCommitted":{
            "type":"integer"
        },
        "numCommits":{
            "type":"integer"
        }
    },
    "description":"Represents a status of records being imported by this POST request."
}

Nested Schema : ImportRecordsSummary

Type: object

Represents a summary of records imported by this POST request.

Show Source

• numRecordsInvalid(optional): integer
• numRecordsProcessed(optional): integer
• numRecordsStatus(optional): integer

{
    "type":"object",
    "properties":{
        "numRecordsProcessed":{
            "type":"integer"
        },
        "numRecordsInvalid":{
            "type":"integer"
        },
        "numRecordsStatus":{
            "type":"integer"
        }
    },
    "description":"Represents a summary of records imported by this POST request."
}

Nested Schema : links

Type: array

Show Source

• Array of: object Link
  Represents a link to a gsdata resource.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

Nested Schema : Link

Type: object

Represents a link to a gsdata resource.

Show Source

• href(optional): string
• rel(optional): string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    },
    "description":"Represents a link to a gsdata resource."
}

Back to Top