django serializer with nested column

Question

I'm calling the following serializer -

class ResourceSerializer(serializers.ModelSerializer):

    class Meta:
        model = Resmst
        resource_name = 'resmst'
        fields = ('resmst_id', 'resmst_name', 'resmst_desc', 'resmst_limit', 'resmst_inuse', 'resmst_active', 'resmst_lstchgtm', 
            'resmst_prntid', 'resmst_owner', 'resmst_public', 'resmst_locked', 'resmst_offline')
        read_only_fields = ('resmst_id',)

resmst_owner is a FK relation to another table. What I want to do is have the serializer display the information from a column where that FK relates.

This is the current json -

[
    {
        "resmst_id": 204, 
        "resmst_name": "GAWK", 
        "resmst_desc": null, 
        "resmst_limit": 1, 
        "resmst_inuse": 0, 
        "resmst_active": "Y", 
        "resmst_lstchgtm": "2014-08-20T11:15:18", 
        "resmst_prntid": null, 
        "resmst_owner": 822, 
        "resmst_public": "Y", 
        "resmst_locked": null, 
        "resmst_offline": 0
    }
]

And this is how I want it to look -

[
    {
        "resmst_id": 204, 
        "resmst_name": "GAWK", 
        "resmst_desc": null, 
        "resmst_limit": 1, 
        "resmst_inuse": 0, 
        "resmst_active": "Y", 
        "resmst_lstchgtm": "2014-08-20T11:15:18", 
        "resmst_prntid": null, 
        "owner_name": "John Smith", 
        "resmst_public": "Y", 
        "resmst_locked": null, 
        "resmst_offline": 0
    }
]

Or am I stuck with having to do it this way -

[
    {
        "resmst_id": 204, 
        "resmst_name": "GAWK", 
        "resmst_desc": null, 
        "resmst_limit": 1, 
        "resmst_inuse": 0, 
        "resmst_active": "Y", 
        "resmst_lstchgtm": "2014-08-20T11:15:18", 
        "resmst_prntid": null, 
        "resmst_owner": {
            "owner_name": "John Smith"
        }, 
        "resmst_public": "Y", 
        "resmst_locked": null, 
        "resmst_offline": 0
    }
]

Community · Accepted Answer · 2017-05-23 10:33:37Z

1

Haven't tested this but it looks like this question. Try to use a SerializerMethodField.

edited May 23, 2017 at 10:33

CommunityBot

11 silver badge

answered Sep 8, 2014 at 16:50

Norman8054

8147 silver badges15 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

whoisearth Over a year ago

Thanks you pointed me in the right direction with the help of @Steven I got it working.

Community · Accepted Answer · 2020-06-20 09:12:55Z

1

I think you should be fine with a regular Field (note that this is readonly).

class ResourceSerializer(serializers.ModelSerializer):
    owner_name = serializers.Field(source='resmst_owner.owner_name')

    class Meta:
        model = Resmst
        resource_name = 'resmst'
        fields = ('resmst_id', 'resmst_name', 'resmst_desc', 'resmst_limit', 
            'resmst_inuse', 'resmst_active', 'resmst_lstchgtm', 
            'resmst_prntid', 'resmst_owner', 'resmst_public', 
            'resmst_locked', 'resmst_offline', 'owner_name', )
        read_only_fields = ('resmst_id',)

Don't forget to add it to Meta.fields (as above).

See the section on Core arguments:

source

The name of the attribute that will be used to populate the field. May be a method that only takes a self argument, such as Field(source='get_absolute_url'), or may use dotted notation to traverse attributes, such as Field(source='user.email').

The value source='*' has a special meaning, and is used to indicate that the entire object should be passed through to the field. This can be useful for creating nested representations. (See the implementation of the PaginationSerializer class for an example.)

Defaults to the name of the field.

edited Jun 20, 2020 at 9:12

CommunityBot

11 silver badge

answered Sep 8, 2014 at 17:13

Steven

2,69815 silver badges15 bronze badges

1 Comment

whoisearth Over a year ago

Thanks the first one got me the solution but this one gave me the more elegant "what I was looking for".

Collectives™ on Stack Overflow

django serializer with nested column

2 Answers 2

1 Comment

1 Comment

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

1 Comment

1 Comment

Your Answer

Sign up or log in

Post as a guest

Linked

Related