Jump to

• Request
• Response

Create ResourceCodeAssignment

post

/resourceCodeAssignment

Send a request to this endpoint to create one or more ResourceCodeAssignment. An application object will be created for each JSON object provided in the request body

Request

Header Parameters

• Authorization(required):
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

A list of ResourceCodeAssignment objects.

Root Schema : List<ResourceCodeAssignment>

Type: array

Title: List<ResourceCodeAssignment>

Show Source

• Array of: object ResourceCodeAssignment
  Title: ResourceCodeAssignment

  ResourceCodeAssignment Entity

{
    "title":"List<ResourceCodeAssignment>",
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ResourceCodeAssignment"
    }
}

Nested Schema : ResourceCodeAssignment

Type: object

Title: ResourceCodeAssignment

ResourceCodeAssignment Entity

Show Source

• CreateDate: string (date-time)
  The date this code assignment was created.
• CreateUser: string
  The name of the user that created this code assignment.
• LastUpdateDate: string (date-time)
  The date this code assignment was last updated.
• LastUpdateUser: string
  The name of the user that last updated this code assignment.
• ResourceCodeDescription: string
  The description of the associated resource code.
• ResourceCodeObjectId: integer (int32)
  The unique ID of the associated resource code.
• ResourceCodeTypeName: string
  The name of the parent resource code type.
• ResourceCodeTypeObjectId: integer (int32)
  The unique ID of the parent resource code type.
• ResourceCodeValue: string
  The value of the associated resource code.
• ResourceId: string
  The short code that uniquely identifies the associated resource.
• ResourceName: string
  The name of the resource to which the resource code is assigned.
• ResourceObjectId: integer (int32)
  The unique ID of the resource to which the resource code is assigned.

{
    "title":"ResourceCodeAssignment",
    "type":"object",
    "properties":{
        "CreateDate":{
            "type":"string",
            "description":"The date this code assignment was created.",
            "format":"date-time"
        },
        "CreateUser":{
            "type":"string",
            "description":"The name of the user that created this code assignment."
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date this code assignment was last updated.",
            "format":"date-time"
        },
        "LastUpdateUser":{
            "type":"string",
            "description":"The name of the user that last updated this code assignment."
        },
        "ResourceCodeDescription":{
            "type":"string",
            "description":"The description of the associated resource code."
        },
        "ResourceCodeObjectId":{
            "type":"integer",
            "description":"The unique ID of the associated resource code.",
            "format":"int32"
        },
        "ResourceCodeTypeName":{
            "type":"string",
            "description":"The name of the parent resource code type."
        },
        "ResourceCodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent resource code type.",
            "format":"int32"
        },
        "ResourceCodeValue":{
            "type":"string",
            "description":"The value of the associated resource code."
        },
        "ResourceId":{
            "type":"string",
            "description":"The short code that uniquely identifies the associated resource."
        },
        "ResourceName":{
            "type":"string",
            "description":"The name of the resource to which the resource code is assigned."
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the resource to which the resource code is assigned.",
            "format":"int32"
        }
    },
    "description":"ResourceCodeAssignment Entity"
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

ResourceCodeAssignment Created.

Body ()

Root Schema : CreateResourceCodeAssignmentsResponse

Type: object

Title: CreateResourceCodeAssignmentsResponse

CreateResourceCodeAssignmentsResponse Entity

Show Source

• ResourceCodeTypeObjectId: integer (int32)
  The unique ID of the parent resource code type.
• ResourceObjectId: integer (int32)
  The unique ID of the resource to which the resource code is assigned.

{
    "title":"CreateResourceCodeAssignmentsResponse",
    "type":"object",
    "properties":{
        "ResourceCodeTypeObjectId":{
            "type":"integer",
            "description":"The unique ID of the parent resource code type.",
            "format":"int32"
        },
        "ResourceObjectId":{
            "type":"integer",
            "description":"The unique ID of the resource to which the resource code is assigned.",
            "format":"int32"
        }
    },
    "description":"CreateResourceCodeAssignmentsResponse Entity"
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top