Jump to

• Request
• Response

Update a social network

patch

/fscmRestApi/resources/11.13.18.05/personProfiles/{PartyId}/child/socialNetworks/{SocialNetworkId}

Request

Path Parameters

• PartyId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• SocialNetworkId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred social network address.
• ProviderCode: string
  Title: Provider

  Maximum Length: 30

  The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• ProviderMeaning: string
  Title: Provider

  The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• SocialNetworkAddress: string
  Title: Social Network Address

  Maximum Length: 200

  The social network address of the person.

{
    "type":"object",
    "properties":{
        "ProviderMeaning":{
            "title":"Provider",
            "type":"string",
            "description":"The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SocialNetworkAddress":{
            "title":"Social Network Address",
            "maxLength":"200",
            "type":"string",
            "description":"The social network address of the person.",
            "nullable":false
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred social network address.",
            "nullable":true,
            "default":false
        },
        "ProviderCode":{
            "title":"Provider",
            "maxLength":"30",
            "type":"string",
            "description":"The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : personProfiles-socialNetworks-item-response

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PreferredFlag: boolean
  Title: Preferred

  Maximum Length: 1

  Default Value: false

  Indicates the preferred social network address.
• ProviderCode: string
  Title: Provider

  Maximum Length: 30

  The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• ProviderMeaning: string
  Title: Provider

  The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.
• SocialNetworkAddress: string
  Title: Social Network Address

  Maximum Length: 200

  The social network address of the person.
• SocialNetworkId: integer (int64)
  Title: Social Network ID

  Read Only: true

  The unique identifier for the social network.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProviderMeaning":{
            "title":"Provider",
            "type":"string",
            "description":"The meaning of the provider code. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":true,
            "x-queryable":false
        },
        "SocialNetworkId":{
            "title":"Social Network ID",
            "type":"integer",
            "description":"The unique identifier for the social network.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SocialNetworkAddress":{
            "title":"Social Network Address",
            "maxLength":"200",
            "type":"string",
            "description":"The social network address of the person.",
            "nullable":false,
            "x-queryable":true
        },
        "PreferredFlag":{
            "title":"Preferred",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates the preferred social network address.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "ProviderCode":{
            "title":"Provider",
            "maxLength":"30",
            "type":"string",
            "description":"The instant messaging type such as Yahoo, MSN or ICQ. A list of accepted values is defined in the lookup type HZ_INSTANT_MESSENGER_TYPE.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

SocialNetworkProviderLOV

Operation: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

Parameters:

• finder: LookupTypeFinder%3BLookupType%3DHZ_INSTANT_MESSENGER_TYPE%2CLookupCode%3D{ProviderCode}

The following properties are defined on the LOV link relation:

• Source Attribute: ProviderCode; Target Attribute: LookupCode
• Display Attribute: Meaning

Back to Top