Skip to main content
Browse Documentation

Getting an entry

Created by Richard Saunders, last modified by Scott Yearsley on 31 Jan 2019

Get by Guid id

Gets an entry by its Guid identifier.

Syntax

public Entry Get(Guid id, string language = null, int linkDepth = 0, IList<string> fields = null)
{
}

Parameters

id

Type: Guid
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist.

Examples

// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Entry movie = client.Entries.Get(movieGuid, "fr-fr", 3, new[] {"title"});

Get typed model by Guid id

Gets a typed entry model by its Guid identifier.

Syntax

public T Get<T>(Guid id, string language = null, int linkDepth = 0, IList<string> fields = null) where T: class
{
}

Parameters

T

The model class, either a plain class or inheriting from EntryModel.

id

Type: Guid
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist.

Examples

public class Movie
{
    public string Title { get; set; }

    public DateTime DateOfRelease { get; set; }
}
// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Movie movie = client.Entries.Get<Movie>(movieGuid, "fr-fr", 3, new[] {"title"});

Get by string id

Gets an entry by its identifier.

Syntax

public Entry Get(string id, string languageCode = null, int linkDepth = 0, IList<string> fields = null)
{
}

Parameters

id

Type: string
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist. If the id string is not a valid Guid format then an exception will be thrown.

Examples

// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Entry movie = client.Entries.Get("456e5f2a-a1cf-4520-a46c-e5f22ed299e8", "fr-fr", 3, new[] {"title"});

Get typed model by string id

Gets a typed entry model by its identifier.

Syntax

public T Get<T>(string id, string languageCode = null, int linkDepth = 0, IList<string> fields = null) where T: class
{
}

Parameters

T

The model class, either a plain class or inheriting from EntryModel.

id

Type: string
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist. If the id string is not a valid Guid format then an exception will be thrown.

Examples

public class Movie
{
    public string Title { get; set; }

    public DateTime DateOfRelease { get; set; }
}
// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Movie movie = client.Entries.Get<Movie>("456e5f2a-a1cf-4520-a46c-e5f22ed299e8", "fr-fr", 3, new[] {"title"});

Get by Guid id async

Gets an entry by its Guid identifier asynchronously.

Syntax

public async Task<Entry> GetAsync(Guid id, string language = null, int linkDepth = 0, IList<string> fields = null)
{
}

Parameters

id

Type: Guid
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist.

Examples

// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Entry movie = await client.Entries.GetAsync(movieGuid, "fr-fr", 3, new[] {"title"});

Get typed model by Guid id async

Gets a typed model by its Guid identifier asynchronously.

Syntax

public async Task<T> GetAsync<T>(Guid id, string language = null, int linkDepth = 0, IList<string> fields = null) where T: class
{
}

Parameters

T

The model class, either a plain class or inheriting from EntryModel.

id

Type: Guid
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry, with a maximum depth value of 10 - larger values will be handled as being 10. By default, no entry data is resolved for linked entries. Please note: linked assets are always fully resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist.

Examples

public class Movie
{
    public string Title { get; set; }

    public DateTime DateOfRelease { get; set; }
}
// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry as a Movie type, returning just the title and resolving links to a depth of 3
Movie movie = await client.Entries.GetAsync<Movie>(movieGuid, "fr-fr", 3, new[] {"title"});

Get by string id async

Gets an entry by its string identifier asynchronously.

Syntax

public async Task<Entry> GetAsync(string id, string language = null, int linkDepth = 0, IList<string> fields = null)
{
}

Parameters

id

Type: string
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry. The max depth that can be specified is 10 - larger values will be handled as being 10. By default, no entry data is resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist. If the id string is not a valid Guid format then an exception will be thrown.

Examples

// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry, returning just the title and resolving links to a depth of 3
Entry movie = await client.Entries.GetAsync("456e5f2a-a1cf-4520-a46c-e5f22ed299e8", "fr-fr", 3, new[] {"title"});

Get typed model by string id async

Gets an entry by its string identifier asynchronously.

Syntax

public async Task<T> GetAsync<T>(string id, string language = null, int linkDepth = 0, IList<string> fields = null) where T: class
{
}

Parameters

T

The model class, either a plain class or inheriting from EntryModel.

id

Type: string
The id of the entry.

language

Type: string
The specified language variation for the entry. If no value is provided then the project default language is used.

linkDepth

Type: int
The depth at which to resolve the full entry data for a linked entry. The max depth that can be specified is 10 - larger values will be handled as being 10. By default, no entry data is resolved.

fields

Type: IList<string>
The list of fields to include in the entry. By default, all fields are returned.

Remarks

Returns null if an entry with an id matching the specified id does not exist. If the id string is not a valid Guid format then an exception will be thrown.

Examples

public class Movie
{
    public string Title { get; set; }

    public DateTime DateOfRelease { get; set; }
}
// Create a client
var client = ContensisClient.Create();

// Get the french variation of the movie entry as a Movie type, returning just the title and resolving links to a depth of 3
Movie movie = await client.Entries.GetAsync<Movie>("456e5f2a-a1cf-4520-a46c-e5f22ed299e8", "fr-fr", 3, new[] {"title"});