Jump to

• Request
• Response

Create a fund request resource

post

/crmRestApi/resources/11.13.18.05/mdfRequests/{FundRequestCode}/child/FundRequestResource

Request

Path Parameters

• FundRequestCode(required): string
  The code indicating the user-defined, unique label for the MDF request.

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.
• Upsert-Mode:
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full.
• FundRequestCode: string
  Title: Code

  Maximum Length: 100

  The public unique identifier for the marketing fund request.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF request associated with the resource. This is a system-generated value.
• FundRequestResourceId: integer (int64)
  Title: MDF Request Resource ID

  The unique identifier of the resource in the MDF request team. This is a system-generated value.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date when the user last updated the record.

{
    "type":"object",
    "properties":{
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            }
        },
        "FundRequestResourceId":{
            "title":"MDF Request Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource in the MDF request team. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FundRequestCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The public unique identifier for the marketing fund request.",
            "nullable":false
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date when the user last updated the record.",
            "format":"date-time",
            "nullable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request associated with the resource. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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 : mdfRequests-FundRequestResource-item-response

Type: object

Show Source

• AccessLevelCode: string
  Title: Access

  Maximum Length: 30

  The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource in the MDF request team.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the resource was created in the MDF request team.
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 320

  The e-mail address of the MDF Request team member associated with the MDF Request.
• FormattedPhoneNumber: string
  Title: Phone

  Read Only: true

  The phone number of the MDF Request team member associated with the MDF Request.
• FundRequestCode: string
  Title: Code

  Maximum Length: 100

  The public unique identifier for the marketing fund request.
• FundRequestId: integer (int64)
  Title: Fund Request ID

  The unique identifier of the MDF request associated with the resource. This is a system-generated value.
• FundRequestResourceId: integer (int64)
  Title: MDF Request Resource ID

  The unique identifier of the resource in the MDF request team. This is a system-generated value.
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true

  The date and time when the MDF request team member record was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the MDF request team member record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the MDF request team member record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MemberFunctionCode: string
  Title: Function

  Maximum Length: 30

  The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor.
• OwnerFlag: boolean
  Title: Owner

  Read Only: true

  Indicates whether the MDF Request team member is the owner of the MDF Request. The default value is true.
• ResourceId: integer (int64)
  Title: Resource ID

  The unique identifier of the resource.
• ResourceName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  The name of the MDF Request team member associated with the MDF Request.
• ResourcePartyNumber: string
  Title: Resource Party Number

  Read Only: true

  Maximum Length: 30

  The public unique identifier for the resource.
• ResourceUsername: string
  Title: Resource User Name

  Read Only: true

  The login username of the MDF Request team member associated with the MDF Request.
• UserLastUpdateDate: string (date-time)
  Title: User Last Update Date

  The date when the user last updated the record.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the MDF request team member record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the resource was created in the MDF request team.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the resource in the MDF request team.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessLevelCode":{
            "title":"Access",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the level of access of the resource in the MDF request team. A list of valid values is defined in the lookup AccessLevelCode. The valid values are View, Edit, or Full.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceName":{
            "title":"Name",
            "maxLength":"360",
            "type":"string",
            "description":"The name of the MDF Request team member associated with the  MDF Request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OwnerFlag":{
            "title":"Owner",
            "type":"boolean",
            "description":"Indicates whether the MDF Request team member is the owner of the MDF Request. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceUsername":{
            "title":"Resource User Name",
            "type":"string",
            "description":"The login username of the MDF Request team member associated with the MDF Request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "FundRequestCode":{
            "title":"Code",
            "maxLength":"100",
            "type":"string",
            "description":"The public unique identifier for the marketing fund request.",
            "nullable":false,
            "x-queryable":true
        },
        "UserLastUpdateDate":{
            "title":"User Last Update Date",
            "type":"string",
            "description":"The date when the user last updated the record.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "FundRequestId":{
            "title":"Fund Request ID",
            "type":"integer",
            "description":"The unique identifier of the MDF request associated with the resource. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":"320",
            "type":"string",
            "description":"The e-mail address of the MDF Request team member associated with the MDF Request.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ResourceId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov",
                "precision":"18"
            },
            "x-queryable":true
        },
        "FundRequestResourceId":{
            "title":"MDF Request Resource ID",
            "type":"integer",
            "description":"The unique identifier of the resource in the MDF request team. This is a system-generated value.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Resource Party Number",
            "maxLength":"30",
            "type":"string",
            "description":"The public unique identifier for the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MemberFunctionCode":{
            "title":"Function",
            "maxLength":"30",
            "type":"string",
            "description":"The code indicating the function of the MDF Request team member. A list of valid values is defined in the lookup MemberFunctionCode. The valid values are Channel Account Manager, Channel Sales Manager, Marketing Specialist, Support Specialist, Sales Representative, Sales Manager, or MDF Request Processor.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the MDF Request team member associated with the MDF Request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date and time when the MDF request team member record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the MDF request team member record.",
            "nullable":true,
            "readOnly":true,
            "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

AccessLevelCodesVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_MDF_ACCESS_LVL%2CBindLookupCode%3D{AccessLevelCode}

The lookups resource is used to view standard lookup codes.

MemberFunctionCodesVA

Operation: /crmRestApi/resources/11.13.18.05/fndStaticLookups

Parameters:

• finder: LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupCode%3D{MemberFunctionCode}%2CBindLookupType%3DORA_MKT_MDFREQUEST_FUNC

The lookups resource is used to view standard lookup codes.

ResourceVOVA

Operation: /crmRestApi/resources/11.13.18.05/resources

A front office person. For example, sales persons or partner members can be tagged as resources.

Back to Top