Jump to

• Request
• Response

Create an archived contract approval

post

/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/ContractArchivedApproval

Request

Path Parameters

• contractsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts to get the hash key.

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

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 : contracts-ContractArchivedApproval-item-response

Type: object

Show Source

• AcquiredBy: string
  Read Only: true

  Maximum Length: 400

  The acquired by user of the archived contract approval.
• ActionDate: string (date-time)
  Read Only: true

  The action date of the archived contract approval.
• Assignee: string
  Read Only: true

  Maximum Length: 400

  The assignee of the archived contract approval.
• AssigneeType: string
  Read Only: true

  Maximum Length: 20

  The assignee type of the archived contract approval.
• CompletedDate: string (date-time)
  Title: Completion Date

  Read Only: true

  The completion date of the archived contract approval.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the archived contract approval.
• CreationDate: string (date-time)
  Read Only: true

  The date when the archived contract approval.
• DisplayName: string
  Title: Assignee

  Read Only: true

  Maximum Length: 360

  The display name of the archived contract approval.
• Domain: string
  Read Only: true

  Maximum Length: 64

  The domain of the archived contract approval.
• EffectiveEndDate: string (date)
  Read Only: true

  The effective end date of the archived contract approval.
• EffectiveStartDate: string (date)
  Read Only: true

  The effective start date of the archived contract approval.
• IdentificationKey: string
  Read Only: true

  Maximum Length: 100

  The identification key of the archived contract approval.
• LastUpdateDate: string (date-time)
  Read Only: true

  The last update date of the archived contract approval.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the archived contract approval.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  The object version number of the archived contract approval.
• Outcome: string
  Title: Outcome

  Read Only: true

  Maximum Length: 100

  The outcome of the archived contract approval.
• Participant: string
  Read Only: true

  Maximum Length: 200

  The participant of the archived contract approval.
• ParticipantCode: string
  Read Only: true

  Maximum Length: 200

  The participant code of the archived contract approval.
• PersonNameId: integer (int64)
  Read Only: true

  The person name ID of the archived contract approval.
• RootTaskId: string
  Read Only: true

  Maximum Length: 64

  The root task ID of the archived contract approval.
• Stage: string
  Title: Stage

  Read Only: true

  Maximum Length: 200

  The stage of the archived contract approval.
• StageCode: string
  Read Only: true

  Maximum Length: 200

  The stage code of the archived contract approval.
• TaskId: string
  Read Only: true

  Maximum Length: 64

  The task ID of the archived contract approval.
• UserId: integer (int64)
  Read Only: true

  The user ID of the archived contract approval.
• Username: string
  Read Only: true

  Maximum Length: 100

  The user name of the archived contract approval.
• Version: number
  Read Only: true

  The version of the archived contract approval.

{
    "type":"object",
    "properties":{
        "AcquiredBy":{
            "maxLength":400,
            "type":"string",
            "description":"The acquired by user of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionDate":{
            "type":"string",
            "description":"The action date of the archived contract approval.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Assignee":{
            "maxLength":400,
            "type":"string",
            "description":"The assignee of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssigneeType":{
            "maxLength":20,
            "type":"string",
            "description":"The assignee type of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CompletedDate":{
            "title":"Completion Date",
            "type":"string",
            "description":"The completion date of the archived contract approval.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who created the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the archived contract approval.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayName":{
            "title":"Assignee",
            "maxLength":360,
            "type":"string",
            "description":"The display name of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Domain":{
            "maxLength":64,
            "type":"string",
            "description":"The domain of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The effective end date of the archived contract approval.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The effective start date of the archived contract approval.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IdentificationKey":{
            "maxLength":100,
            "type":"string",
            "description":"The identification key of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The last update date of the archived contract approval.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number of the archived contract approval.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "Outcome":{
            "title":"Outcome",
            "maxLength":100,
            "type":"string",
            "description":"The outcome of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Participant":{
            "maxLength":200,
            "type":"string",
            "description":"The participant of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParticipantCode":{
            "maxLength":200,
            "type":"string",
            "description":"The participant code of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonNameId":{
            "type":"integer",
            "description":"The person name ID of the archived contract approval.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RootTaskId":{
            "maxLength":64,
            "type":"string",
            "description":"The root task ID of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Stage":{
            "title":"Stage",
            "maxLength":200,
            "type":"string",
            "description":"The stage of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StageCode":{
            "maxLength":200,
            "type":"string",
            "description":"The stage code of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TaskId":{
            "maxLength":64,
            "type":"string",
            "description":"The task ID of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UserId":{
            "type":"integer",
            "description":"The user ID of the archived contract approval.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "maxLength":100,
            "type":"string",
            "description":"The user name of the archived contract approval.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Version":{
            "type":"number",
            "description":"The version of the archived contract approval.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top