Jump to

• Request
• Response

Create a consent agreement

post

/fscmRestApi/resources/11.13.18.05/hedElectronicConsents

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

• ConsentCode(required): string
  Title: Consent Code

  Maximum Length: 80

  The user-defined code of the consent agreement.
• consentDetails: array Consent Details
  Title: Consent Details

  Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.
• ConsentLanguage(required): string
  Title: Primary Language

  Maximum Length: 4

  The primary language of the consent agreement text.
• PartyId(required): integer (int64)
  Title: Party ID

  Unique identifier of the student.
• SourceObjectCode(required): string
  Title: Agreement Source Code

  Maximum Length: 30

  Code of the source of the agreement.
• SourceObjectId(required): integer (int64)
  Title: Agreement Source ID

  Unique identifier of the source of the agreement.

{
    "required":[
        "ConsentCode",
        "ConsentLanguage",
        "PartyId",
        "SourceObjectCode",
        "SourceObjectId"
    ],
    "type":"object",
    "properties":{
        "ConsentCode":{
            "title":"Consent Code",
            "maxLength":80,
            "type":"string",
            "description":"The user-defined code of the consent agreement.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConsentLanguage":{
            "title":"Primary Language",
            "maxLength":4,
            "type":"string",
            "description":"The primary language of the consent agreement text.",
            "nullable":false
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the student.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SourceObjectCode":{
            "title":"Agreement Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the source of the agreement.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "SourceObjectId":{
            "title":"Agreement Source ID",
            "type":"integer",
            "description":"Unique identifier of the source of the agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "consentDetails":{
            "title":"Consent Details",
            "type":"array",
            "description":"Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.",
            "items":{
                "$ref":"#/components/schemas/hedElectronicConsents-consentDetails-item-post-request"
            }
        }
    }
}

Nested Schema : Consent Details

Type: array

Title: Consent Details

Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.

Show Source

• Array of: object hedElectronicConsents-consentDetails-item-post-request

{
    "title":"Consent Details",
    "type":"array",
    "description":"Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.",
    "items":{
        "$ref":"#/components/schemas/hedElectronicConsents-consentDetails-item-post-request"
    }
}

Nested Schema : hedElectronicConsents-consentDetails-item-post-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : hedElectronicConsents-item-response

Type: object

Show Source

• ConsentCode: string
  Title: Consent Code

  Maximum Length: 80

  The user-defined code of the consent agreement.
• consentDetails: array Consent Details
  Title: Consent Details

  Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.
• ConsentLanguage: string
  Title: Primary Language

  Maximum Length: 4

  The primary language of the consent agreement text.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  Date that the consent agreement was created.
• ElectronicConsentId: integer (int64)
  Title: Electronic Consent ID

  Read Only: true

  Unique identifier of the consent agreement.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyId: integer (int64)
  Title: Party ID

  Unique identifier of the student.
• PartyName: string
  Title: Name

  Read Only: true

  Maximum Length: 360

  Name of the student.
• SourceObjectCode: string
  Title: Agreement Source Code

  Maximum Length: 30

  Code of the source of the agreement.
• SourceObjectId: integer (int64)
  Title: Agreement Source ID

  Unique identifier of the source of the agreement.
• SourceObjectMeaning: string
  Title: Agreement Source Meaning

  Read Only: true

  Maximum Length: 80

  The object that's the source of the agreement.
• SourceObjectName: string
  Title: Agreement Source Name

  Read Only: true

  Maximum Length: 255

  Name of the source of the agreement, such as a tax document that requires consent or a payment plan that requires agreement to terms and conditions.

{
    "type":"object",
    "properties":{
        "ConsentCode":{
            "title":"Consent Code",
            "maxLength":80,
            "type":"string",
            "description":"The user-defined code of the consent agreement.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ConsentLanguage":{
            "title":"Primary Language",
            "maxLength":4,
            "type":"string",
            "description":"The primary language of the consent agreement text.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date that the consent agreement was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ElectronicConsentId":{
            "title":"Electronic Consent ID",
            "type":"integer",
            "description":"Unique identifier of the consent agreement.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"Unique identifier of the student.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Name",
            "maxLength":360,
            "type":"string",
            "description":"Name of the student.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "PartyId"
                ]
            },
            "x-queryable":true
        },
        "SourceObjectCode":{
            "title":"Agreement Source Code",
            "maxLength":30,
            "type":"string",
            "description":"Code of the source of the agreement.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceObjectId":{
            "title":"Agreement Source ID",
            "type":"integer",
            "description":"Unique identifier of the source of the agreement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceObjectMeaning":{
            "title":"Agreement Source Meaning",
            "maxLength":80,
            "type":"string",
            "description":"The object that's the source of the agreement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceObjectName":{
            "title":"Agreement Source Name",
            "maxLength":255,
            "type":"string",
            "description":"Name of the source of the agreement, such as a tax document that requires consent or a payment plan that requires agreement to terms and conditions.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "SourceObjectCode",
                    "SourceObjectId"
                ]
            },
            "x-queryable":true
        },
        "consentDetails":{
            "title":"Consent Details",
            "type":"array",
            "description":"Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.",
            "items":{
                "$ref":"#/components/schemas/hedElectronicConsents-consentDetails-item-response"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Consent Details

Type: array

Title: Consent Details

Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.

Show Source

• Array of: object hedElectronicConsents-consentDetails-item-response

{
    "title":"Consent Details",
    "type":"array",
    "description":"Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.",
    "items":{
        "$ref":"#/components/schemas/hedElectronicConsents-consentDetails-item-response"
    }
}

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 : hedElectronicConsents-consentDetails-item-response

Type: object

Show Source

• ConsentCode: string
  Title: Consent Code

  Read Only: true

  Maximum Length: 30

  The user-defined code of the consent agreement.
• ConsentDetail: string (byte)
  Title: Consent Detail

  Read Only: true

  The details of the consent agreement.
• ConsentDetailId: integer (int64)
  Title: Consent Detail ID

  Read Only: true

  Unique identifier of the consent agreement details.
• ConsentMeaning: string
  Title: Consent Name

  Read Only: true

  Maximum Length: 80

  Name of the consent details.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ConsentCode":{
            "title":"Consent Code",
            "maxLength":30,
            "type":"string",
            "description":"The user-defined code of the consent agreement.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ConsentDetail":{
            "title":"Consent Detail",
            "type":"string",
            "description":"The details of the consent agreement.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConsentDetailId":{
            "title":"Consent Detail ID",
            "type":"integer",
            "description":"Unique identifier of the consent agreement details.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ConsentMeaning":{
            "title":"Consent Name",
            "maxLength":80,
            "type":"string",
            "description":"Name of the consent details.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

consentCodesLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{ConsentCode}%2CLookupType%3DORA_HEY_CONSENT_DETAIL_TYPE

The following properties are defined on the LOV link relation:

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

consentDetails

Operation: /fscmRestApi/resources/11.13.18.05/hedElectronicConsents/{ElectronicConsentId}/child/consentDetails

Parameters:

• ElectronicConsentId: $request.path.ElectronicConsentId

Consent details represent the details that are associated with the consent agreement. For example, retrieving the details of a payment plan agreement will return a summary, terms and conditions, and agreement text.

sourceObjectsLOV

Operation: /fscmRestApi/resources/11.13.18.05/heyLookups

Parameters:

• finder: ByLookupTypeFinder%3BLookupCode%3D{SourceObjectCode}%2CLookupType%3DORA_HEY_CONSENT_SOURCE_TYPE

The following properties are defined on the LOV link relation:

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

Back to Top