Reference

Blogcategory

The blogcategory object

Attributes
Id: int required, autogenerated, unique
The unique identifier for this blogcategory
BusinessId: Id required
LanguageId: Id optional
Title: string required
UniqueId: Guid required, autogenerated, unique
The globally unique identifier for this blogcategory
SystemId: string optional api-only
User defined data about this blogcategory. This property can only be seen and updated using the API.

Json Structure Example


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "LanguageId": 12345678,
  "Title": "Title",
  "UniqueId": "93875dfc-a46c-42c2-8092-ef2fb7f474e5",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Find a BlogCategory

This endpoint allows you to GET a list of blogcategories based on one or more filter querystring parameters.

GET https://spaces.nexudus.com/api/content/blogcategories?...

πŸ”’ Requires role "BlogCategory-List"

Pagination querystring parameters
Lets control how many records to return at a time and their order.
page integer optional
?page=1
size integer optional default=25
Sets the maximum number of records to return each page of results.
?size=25
orderby string optional default=Title
Sets the property to use when ordering the results of the search.
?orderby=Id
dir 'ascending' or 'descending' optional default=SortDirection.Ascending
Sets the direction to use when ordering the records.
?sort=ascending

Search querystring parameters
Lets you search blogcategory records based on their different properties.
Id number
?Id=12345678
BlogCategory_Business Business
?BlogCategory_Business=...
BlogCategory_Language Language
?BlogCategory_Language=...
BlogCategory_Title string
?BlogCategory_Title=...
BlogCategory_BlogPosts List of BlogPost
?BlogCategory_BlogPosts=...

Range search querystring parameters
Lets you search blogcategory records based on a range of date or numeric values.
To_BlogCategory_CreatedOn date
?To_BlogCategory_CreatedOn=2010-01-01T20:32
From_BlogCategory_CreatedOn date
?From_BlogCategory_CreatedOn=2010-01-01T20:32
To_BlogCategory_UpdatedOn date
?To_BlogCategory_UpdatedOn=2010-01-01T20:32
From_BlogCategory_UpdatedOn date
?From_BlogCategory_UpdatedOn=2010-01-01T20:32

Example request

GET https://spaces.nexudus.com/api/content/blogcategories?BlogCategory_Title=...
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Language": ,
        "Title": "Title",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "61a49ce9-aa05-4f37-bc54-25db8010bc19",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Id",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 25,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 60,
    "TotalPages": 3
}


Find BlogCategories by IDs

Gets one or more blogcategory records based on their Id.
GET https://spaces.nexudus.com/api/content/blogcategories?BlogCategory_Id=[:id1,:id2,...]

πŸ”’ Requires role "BlogCategory-List"

Querystring parameters
BlogCategory_Id: array requried
?BlogCategory_Id=[12345678,87654651]

Example request

GET https://spaces.nexudus.com/api/content/blogcategories?BlogCategory_Id=[1234567,9876541]
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
    "Records": [{
        "Id": 1234567,
        "Business": ,
        "Language": ,
        "Title": "Title",
        "CreatedOn": "2018-07-03T06:23:01Z",
        "UpdatedOn": "2020-01-01T21:57:21Z",
        "UpdatedBy": "System",
        "UniqueId": "17ddf899-476b-488b-b436-21a87080c0d9",
        "SystemId": "{ metadata: { id: 887766, processed: true } }"
    }],
    "CurrentPageSize": 25,
    "CurrentPage": 1,
    "CurrentOrderField": "Title",
    "CurrentSortDirection": 1,
    "FirstItem": 1,
    "HasNextPage": true,
    "HasPreviousPage": false,
    "LastItem": 1,
    "PageNumber": 1,
    "PageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1
}


Get single BlogCategory by Id

Gets one blogcategory record by its Id.
GET https://spaces.nexudus.com/api/content/blogcategories/:Id

πŸ”’ Requires role "BlogCategory-Read"

URL parameters
Id: number requried

Example request

GET https://spaces.nexudus.com/api/content/blogcategories/1234567
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example response


{
  "Id": 1234567,
  "BusinessId": 12345678,
  "LanguageId": 12345678,
  "Title": "Title",
  "CreatedOn": "2018-07-03T06:23:01Z",
  "UpdatedOn": "2020-01-01T21:57:21Z",
  "UpdatedBy": "System",
  "UniqueId": "cdf42e70-c1b1-4b33-bfba-e65078208a1e",
  "SystemId": "{ metadata: { id: 887766, processed: true } }"
}


Create new BlogCategory

Creates a new blogcategory.
POST https://spaces.nexudus.com/api/content/blogcategories

πŸ”’ Requires role "BlogCategory-Create"

Body parameters
BusinessId: number required
LanguageId: number optional
Title: string required

Example request

POST https://spaces.nexudus.com/api/content/blogcategories
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "BusinessId": 12345678,
    "LanguageId": 12345678,
    "Title": "Title",
    "BlogPosts": [12345678, 87654321],
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully created.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Update BlogCategory

Updates an existing blogcategory.
PUT https://spaces.nexudus.com/api/content/blogcategories

PUT requests require ALL record properties to be submitted with every request. Any missing properties will be cleared or set to false.

πŸ”’ Requires role "BlogCategory-Edit"

Body parameters
Id: number required
The unique Id of the blogcategory to update.
BusinessId: number cleared if missing
LanguageId: number cleared if missing
Title: string cleared if missing

Example request

PUT https://spaces.nexudus.com/api/content/blogcategories
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
    "Id": 12345678,
    "BusinessId": 12345678,
    "LanguageId": 12345678,
    "Title": "Title",
    "BlogPosts": [12345678, 87654321],
}


Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "Record 'Name of the record' has been succesfully updated.",
    "Value": {
        "Id": 12354678
    }
}


Example invalid response


{
    "Status": 500,
    "Message": "Name: may not be null or empty",
    "Value": null,
    "WasSuccessful": false,
    "Errors": [
        {
            "AttemptedValue": null,
            "Message": "may not be null or empty",
            "PropertyName": "Name"
        },
    ]
}


Delete BlogCategory

Deletes an existing blogcategory by its Id.
DELETE https://spaces.nexudus.com/api/content/blogcategories/:Id

πŸ”’ Requires role "BlogCategory-Delete"

URL parameters
Id: number required
The unique Id of the blogcategory to update.

Example request

DELETE https://spaces.nexudus.com/api/content/blogcategories/12345678
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


{
    "Status": 200,
    "WasSuccessful": true,
    "Message": "The record was deleted successfully.",
    "Value": null,
    "OpenInDialog": false,
    "RedirectURL": null,
    "JavaScript": null,
    "Errors": null
}


Commands

Commands allow to perform actions against one or more blogcategory records. Some commands accept only one record while others can run an action for a number of records at the same time. Each command has metadata with information about how it can be used and the amount of records, if any, it needs to run.

Get Commands

Get all commands available to run for blogcategory records.
GET https://spaces.nexudus.com/api/content/blogcategories/commands

Example request

GET https://spaces.nexudus.com/api/content/blogcategories/commands
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

Example valid response


[
	{
		"Key": "COMMAND_KEY_1",
		"Name": "Command 1 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": false,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": false,
		"NeedsEntitiesToRun": true,
		"Order": 2,
		"RequiresParameters": []
	},
	{
		"Key": "COMMAND_KEY_2",
		"Name": "Command 2 english description",
		"AppliesOnlyToMultipleEntities": false,
		"DisplayInDropdown": true,
		"DisplayInDropdownV2": true,
		"AppliesOnlyToOneEntity": true,
		"AppliesOnlyToTwoEntities": false,
		"DisplayInGrid": true,
		"NeedsEntitiesToRun": true,
		"Order": 10,
		"RequiresParameters": 
		[
			{
				"Name": "Parameter 1 description",
				"Type": "string",
			},
			{
				"Name": "Parameter 2 description",
				"Type": "Boolean",
			}
		]
	},
	...
]


Run Command

Runs a command based on its Key and one or more blogcategory record IDs.
POST https://spaces.nexudus.com/api/content/blogcategories/runacommand
πŸ”’ Requires role "BlogCategory-Edit"

Example request

POST https://spaces.nexudus.com/api/content/blogcategories/runcommand
Content-Type: application/json
Authentication: Basic ZXhhbXBsZUBuZXh1ZHVzLmNvbTpFeGFtcGxlMTIzNA==

{
	"Ids":[1329961649],
	"Parameters": 
	[
		{ 
			"Type": "string"
			"Value":987654321
		},
		{
			"Type": "Boolean",
			"Value":true
		},
		...
	],
	"Key":"COMMAND_KEY_2"
}


Example valid response


{
	"Errors": null
	"JavaScript": null
	"Message": "Result description"
	"OpenInDialog": false
	"OpenInWindow": false
	"RedirectURL": null
	"Status": 200
	"UpdatedBy": "email@example.net"
	"UpdatedOn: "2020-06-04T11:40:20Z"
	"Value: {Id: 12345678}
	"WasSuccessful: true
}


Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Please sign in to leave a comment.